Merge pull request #1430 from SteveL-MSFT/deprecate-copy

Add deprecation message to use of `copy`

Author: SteveL-MSFT

dsc/tests/dsc_copy.tests.ps1

@@ -440,4 +440,24 @@ resources:
         $out.results[5].name | Should -Be 'Secondary-2'
         $out.results[5].result.actualState.output | Should -Be 'From 2: Data-1002'
     }
+
+    It 'Use of copy emits a deprecation warning' {
+        $configYaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: "[format('Test-{0}', copyIndex())]"
+  copy:
+    name: testLoop
+    count: 1
+  type: Microsoft.DSC.Debug/Echo
+  properties:
+    output: Hello
+'@
+        $out = dsc -l trace config get -i $configYaml 2>$testdrive/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because ((Get-Content $testdrive/error.log) | Out-String)
+        $out.results.Count | Should -Be 1
+        $out.results[0].name | Should -Be 'Test-0'
+        $out.results[0].result.actualState.output | Should -Be 'Hello'
+        (Get-Content $testdrive/error.log -Raw) | Should -BeLike "*WARN*Copy for loop 'testLoop' is deprecated and will be removed in a future release. See https://github.com/PowerShell/DSC/issues/1429 for more details.*"
+    }
 }

lib/dsc-lib/locales/en-us.toml

@@ -94,6 +94,7 @@ metadataRefreshEnvFound = "Resource returned '_refreshEnv' which indicates envir
 metadataRefreshEnvOnlyAffectsSet = "Resource returned '_refreshEnv' which indicates environment variable refresh is needed but current operation is '%{operation}' which is not 'set', so ignoring"
 metadataRefreshEnvNoOperationContext = "Resource returned '_refreshEnv' which indicates environment variable refresh is needed but no operation context is available"
 metadataRefreshEnvNoContext = "Resource returned '_refreshEnv' which indicates environment variable refresh is needed but no context is available"
+copyDeprecated = "Copy for loop '%{name}' is deprecated and will be removed in a future release. See https://github.com/PowerShell/DSC/issues/1429 for more details."
 
 [configure.parameters]
 importingParametersFromComplexInput = "Importing parameters from complex input"

lib/dsc-lib/src/configure/depends_on.rs

@@ -10,7 +10,7 @@ use crate::types::FullyQualifiedTypeName;
 use rust_i18n::t;
 use serde_json::{Map, Value};
 use super::context::Context;
-use tracing::debug;
+use tracing::{debug, warn};
 
 /// Gets the invocation order of resources based on their dependencies
 ///
@@ -141,6 +141,7 @@ fn unroll_and_push(order: &mut Vec<Resource>, resource: &Resource, parser: &mut
   // if the resource contains `Copy`, unroll it
   if let Some(copy) = &resource.copy {
       debug!("{}", t!("configure.mod.unrollingCopy", name = &copy.name, count = copy.count));
+      warn!("{}", t!("configure.mod.copyDeprecated", name = &copy.name));
       context.process_mode = ProcessMode::Copy;
       context.copy_current_loop_name.clone_from(&copy.name);
       let mut copy_resources = Vec::<Resource>::new();
@@ -214,7 +215,7 @@ fn unroll_and_push(order: &mut Vec<Resource>, resource: &Resource, parser: &mut
                   other: Map::new(),
               }
           });
-          
+
           let mut microsoft = metadata.microsoft.clone().unwrap_or_default();
           let mut copy_loops = microsoft.copy_loops.clone().unwrap_or_default();
           copy_loops.insert(copy.name.clone(), Value::Number(i.into()));