Rename PulumiCmd -> PulumiCommand

Author: julienp

sdk/Pulumi.Automation.Tests/LocalPulumiCmdTests.cs sdk/Pulumi.Automation.Tests/LocalPulumiCommandTests.cs

@@ -12,12 +12,12 @@
 
 namespace Pulumi.Automation.Tests
 {
-    public class LocalPulumiCmdTests
+    public class LocalPulumiCommandTests
     {
         [Fact]
         public async Task CheckVersionCommand()
         {
-            var localCmd = await LocalPulumiCmd.CreateAsync();
+            var localCmd = await LocalPulumiCommand.CreateAsync();
             var extraEnv = new Dictionary<string, string?>();
             var args = new[] { "version" };
 
@@ -64,7 +64,7 @@ private List<string> Lines(string s)
         public async Task InstallDefaultRoot()
         {
             var requestedVersion = new SemVersion(3, 102, 0);
-            await LocalPulumiCmd.Install(new LocalPulumiCmdOptions { Version = requestedVersion });
+            await LocalPulumiCommand.Install(new LocalPulumiCommandOptions { Version = requestedVersion });
             var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
             var pulumiBin = Path.Combine(home, ".pulumi", "versions", requestedVersion.ToString(), "bin", "pulumi");
             Assert.True(File.Exists(pulumiBin));
@@ -78,13 +78,13 @@ public async Task InstallTwice()
             try
             {
                 var requestedVersion = new SemVersion(3, 102, 0);
-                await LocalPulumiCmd.Install(new LocalPulumiCmdOptions { Version = requestedVersion, Root = tempDir });
+                await LocalPulumiCommand.Install(new LocalPulumiCommandOptions { Version = requestedVersion, Root = tempDir });
                 var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
                 var pulumiBin = Path.Combine(home, ".pulumi", "versions", requestedVersion.ToString(), "bin", "pulumi");
                 FileInfo fi1 = new FileInfo(pulumiBin);
                 var t1 = fi1.CreationTime;
                 // Install again with the same options
-                await LocalPulumiCmd.Install(new LocalPulumiCmdOptions { Version = requestedVersion, Root = tempDir });
+                await LocalPulumiCommand.Install(new LocalPulumiCommandOptions { Version = requestedVersion, Root = tempDir });
                 FileInfo fi2 = new FileInfo(pulumiBin);
                 var t2 = fi2.CreationTime;
                 Assert.Equal(t1, t2);
@@ -105,18 +105,18 @@ public async Task VersionCheck()
             {
                 // Install an old version
                 var installed_version = new SemVersion(3, 99, 0);
-                await LocalPulumiCmd.Install(new LocalPulumiCmdOptions { Version = installed_version, Root = dirPath });
+                await LocalPulumiCommand.Install(new LocalPulumiCommandOptions { Version = installed_version, Root = dirPath });
 
                 // Try to create a command with a more recent version
                 var requested_version = new SemVersion(3, 102, 0);
-                await Assert.ThrowsAsync<InvalidOperationException>(() => LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
+                await Assert.ThrowsAsync<InvalidOperationException>(() => LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions
                 {
                     Version = requested_version,
                     Root = dirPath
                 }));
 
                 // Opting out of the version check works
-                await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
+                await LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions
                 {
                     Version = requested_version,
                     Root = dirPath,
@@ -135,13 +135,13 @@ public void PulumiEnvironment()
             var env = new Dictionary<string, string?>{
                 {"PATH", "/usr/bin"}
             };
-            var newEnv = LocalPulumiCmd.PulumiEnvironment(env, "pulumi", false);
+            var newEnv = LocalPulumiCommand.PulumiEnvironment(env, "pulumi", false);
             Assert.Equal("/usr/bin", newEnv["PATH"]);
 
             env = new Dictionary<string, string?>{
                 {"PATH", "/usr/bin"}
             };
-            newEnv = LocalPulumiCmd.PulumiEnvironment(env, "/some/install/root/bin/pulumi", false);
+            newEnv = LocalPulumiCommand.PulumiEnvironment(env, "/some/install/root/bin/pulumi", false);
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
                 Assert.Equal("/some/install/root/bin;/usr/bin", newEnv["PATH"]);
@@ -173,12 +173,12 @@ public void ValidVersionTheory(string currentVersion, bool errorExpected, bool o
 
             if (errorExpected)
             {
-                void ValidatePulumiVersion() => LocalPulumiCmd.ParseAndValidatePulumiVersion(testMinVersion, currentVersion, optOut);
+                void ValidatePulumiVersion() => LocalPulumiCommand.ParseAndValidatePulumiVersion(testMinVersion, currentVersion, optOut);
                 Assert.Throws<InvalidOperationException>(ValidatePulumiVersion);
             }
             else
             {
-                LocalPulumiCmd.ParseAndValidatePulumiVersion(testMinVersion, currentVersion, optOut);
+                LocalPulumiCommand.ParseAndValidatePulumiVersion(testMinVersion, currentVersion, optOut);
             }
         }
 

sdk/Pulumi.Automation/Commands/IPulumiCmd.cs sdk/Pulumi.Automation/Commands/IPulumiCommand.cs

@@ -9,7 +9,7 @@
 
 namespace Pulumi.Automation.Commands
 {
-    public interface IPulumiCmd
+    public interface IPulumiCommand
     {
         SemVersion? Version { get; }
 

sdk/Pulumi.Automation/Commands/LocalPulumiCmd.cs sdk/Pulumi.Automation/Commands/LocalPulumiCommand.cs

@@ -22,9 +22,9 @@
 namespace Pulumi.Automation.Commands
 {
     /// <summary>
-    /// Options to configure a <see cref="LocalPulumiCmd"/> instance.
+    /// Options to configure a <see cref="LocalPulumiCommand"/> instance.
     /// </summary>
-    public class LocalPulumiCmdOptions
+    public class LocalPulumiCommandOptions
     {
         /// <summary>
         /// The version of the Pulumi CLI to install or the minimum version requirement for an existing installation.
@@ -41,9 +41,9 @@ public class LocalPulumiCmdOptions
     }
 
     /// <summary>
-    /// A <see cref="IPulumiCmd"/> implementation that uses a locally installed Pulumi CLI.
+    /// A <see cref="IPulumiCommand"/> implementation that uses a locally installed Pulumi CLI.
     /// </summary>
-    public class LocalPulumiCmd : IPulumiCmd
+    public class LocalPulumiCommand : IPulumiCommand
     {
         // TODO: move to shared place with LocalWorkspace
         private static string SkipVersionCheckVar = "PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK";
@@ -57,13 +57,13 @@ public class LocalPulumiCmd : IPulumiCmd
         public SemVersion? Version { get => _version; }
 
         /// <summary>
-        /// Creates a new LocalPulumiCmd instance.
+        /// Creates a new LocalPulumiCommand instance.
         /// </summary>
-        /// <param name="options">Options to configure the LocalPulumiCmd.</param>
+        /// <param name="options">Options to configure the LocalPulumiCommand.</param>
         /// <param name="cancellationToken">A cancellation token.</param>
         /// <returns></returns>
-        public static async Task<LocalPulumiCmd> CreateAsync(
-            LocalPulumiCmdOptions? options = null,
+        public static async Task<LocalPulumiCommand> CreateAsync(
+            LocalPulumiCommandOptions? options = null,
             CancellationToken cancellationToken = default)
         {
             var command = "pulumi";
@@ -80,10 +80,10 @@ public static async Task<LocalPulumiCmd> CreateAsync(
 
             var optOut = options?.SkipVersionCheck ?? Environment.GetEnvironmentVariable(SkipVersionCheckVar) != null;
             var version = await GetPulumiVersionAsync(minimumVersion, command, optOut, cancellationToken);
-            return new LocalPulumiCmd(command, version);
+            return new LocalPulumiCommand(command, version);
         }
 
-        private LocalPulumiCmd(string command, SemVersion? version)
+        private LocalPulumiCommand(string command, SemVersion? version)
         {
             _command = command;
             _version = version;
@@ -104,11 +104,11 @@ private LocalPulumiCmd(string command, SemVersion? version)
         }
 
         /// <summary>
-        /// Installs the Pulumi CLI if it is not already installed and returns a new LocalPulumiCmd instance.
+        /// Installs the Pulumi CLI if it is not already installed and returns a new LocalPulumiCommand instance.
         /// </summary>
-        /// <param name="options">Options to configure the LocalPulumiCmd.</param>
+        /// <param name="options">Options to configure the LocalPulumiCommand.</param>
         /// <param name="cancellationToken">A cancellation token.</param>
-        public static async Task<LocalPulumiCmd> Install(LocalPulumiCmdOptions? options = null, CancellationToken cancellationToken = default)
+        public static async Task<LocalPulumiCommand> Install(LocalPulumiCommandOptions? options = null, CancellationToken cancellationToken = default)
         {
             var _assemblyVersion = Assembly.GetExecutingAssembly().GetName().Version;
             if (_assemblyVersion == null)
@@ -118,7 +118,7 @@ public static async Task<LocalPulumiCmd> Install(LocalPulumiCmdOptions? options
             var assemblyVersion = new SemVersion(_assemblyVersion.Major, _assemblyVersion.Minor, _assemblyVersion.Build);
             var version = options?.Version ?? assemblyVersion;
             var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
-            var optionsWithDefaults = new LocalPulumiCmdOptions
+            var optionsWithDefaults = new LocalPulumiCommandOptions
             {
                 Version = version,
                 Root = options?.Root ?? Path.Combine(home, ".pulumi", "versions", version.ToString())
@@ -285,22 +285,22 @@ private async Task<CommandResult> RunAsyncInner(
                 stdErrPipe = PipeTarget.Merge(stdErrPipe, PipeTarget.ToDelegate(onStandardError));
             }
 
-            var pulumiCmd = Cli.Wrap("pulumi")
+            var pulumiCommand = Cli.Wrap("pulumi")
                 .WithArguments(PulumiArgs(args, eventLogFile), escape: true)
                 .WithWorkingDirectory(workingDir)
                 .WithEnvironmentVariables(PulumiEnvironment(additionalEnv, _command, debugCommands: eventLogFile != null))
                 .WithStandardOutputPipe(stdOutPipe)
                 .WithStandardErrorPipe(stdErrPipe)
                 .WithValidation(CommandResultValidation.None); // we check non-0 exit code ourselves
 
-            var pulumiCmdResult = await pulumiCmd.ExecuteAsync(cancellationToken);
+            var pulumiCommandResult = await pulumiCommand.ExecuteAsync(cancellationToken);
 
             var result = new CommandResult(
-                pulumiCmdResult.ExitCode,
+                pulumiCommandResult.ExitCode,
                 standardOutput: stdOutBuffer.ToString(),
                 standardError: stdErrBuffer.ToString());
 
-            if (pulumiCmdResult.ExitCode != 0)
+            if (pulumiCommandResult.ExitCode != 0)
             {
                 throw CommandException.CreateFromResult(result);
             }

sdk/Pulumi.Automation/LocalWorkspace.cs

@@ -78,7 +78,7 @@ public static async Task<LocalWorkspace> CreateAsync(
             LocalWorkspaceOptions? options = null,
             CancellationToken cancellationToken = default)
         {
-            var cmd = options?.PulumiCmd ?? await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
+            var cmd = options?.PulumiCommand ?? await LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions
             {
                 SkipVersionCheck = OptOutOfVersionCheck(options?.EnvironmentVariables)
             }, cancellationToken);
@@ -287,7 +287,7 @@ private static async Task<WorkspaceStack> CreateStackHelperAsync(
                 throw new ArgumentNullException(nameof(args.ProjectSettings));
 
             var ws = new LocalWorkspace(
-                await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
+                await LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions
                 {
                     SkipVersionCheck = OptOutOfVersionCheck(),
                 }, cancellationToken),
@@ -304,7 +304,7 @@ private static async Task<WorkspaceStack> CreateStackHelperAsync(
             CancellationToken cancellationToken)
         {
             var ws = new LocalWorkspace(
-                await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
+                await LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions
                 {
                     SkipVersionCheck = OptOutOfVersionCheck()
                 }, cancellationToken),
@@ -316,7 +316,7 @@ await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions
         }
 
         internal LocalWorkspace(
-            IPulumiCmd cmd,
+            IPulumiCommand cmd,
             LocalWorkspaceOptions? options,
             CancellationToken cancellationToken)
             : base(cmd)

sdk/Pulumi.Automation/LocalWorkspaceOptions.cs

@@ -25,7 +25,7 @@ public class LocalWorkspaceOptions
         /// <summary>
         /// The Pulumi CLI installation to use.
         /// </summary>
-        public Commands.IPulumiCmd? PulumiCmd { get; set; }
+        public Commands.IPulumiCommand? PulumiCommand { get; set; }
 
         /// <summary>
         /// The secrets provider to user for encryption and decryption of stack secrets.

sdk/Pulumi.Automation/RemoteWorkspace.cs

@@ -112,7 +112,7 @@ private static async Task<RemoteWorkspaceStack> CreateStackHelperAsync(
             };
 
             var ws = new LocalWorkspace(
-                await LocalPulumiCmd.CreateAsync(new LocalPulumiCmdOptions(), cancellationToken),
+                await LocalPulumiCommand.CreateAsync(new LocalPulumiCommandOptions(), cancellationToken),
                 localArgs,
                 cancellationToken);
             await ws.ReadyTask.ConfigureAwait(false);

sdk/Pulumi.Automation/Workspace.cs

@@ -23,9 +23,9 @@ namespace Pulumi.Automation
     /// </summary>
     public abstract class Workspace : IDisposable
     {
-        internal readonly IPulumiCmd _cmd;
+        internal readonly IPulumiCommand _cmd;
 
-        internal Workspace(IPulumiCmd cmd)
+        internal Workspace(IPulumiCommand cmd)
         {
             this._cmd = cmd;
         }