Fix AzDev module after redesign generation (Azure#27258)

isra-fel · web-flow · commit 497a50dd2c4c · 2025-03-07T16:35:15.000+08:00
diff --git a/tools/AzDev/Tests/ModelTests/ModuleTests.cs b/tools/AzDev/Tests/ModelTests/ModuleTests.cs
@@ -1,5 +1,6 @@
 using System.IO.Abstractions.TestingHelpers;
 using AzDev.Models.Inventory;
+using AzDev.Services;
 
 namespace AzDev.Tests;
 
@@ -20,7 +21,7 @@ public void CanCreateFromFileSystem()
             )}
         });
 
-        var module = Module.FromFileSystem(fs, path);
+        var module = Module.FromFileSystem(fs, new NoopLogger(), path);
         Assert.Equal(path, module.Path);
         Assert.Equal(moduleName, module.Name);
         Assert.Single(module.Projects);
@@ -45,7 +46,7 @@ public void CanRecognizeBothProjectTypes()
             )},
         });
 
-        var module = Module.FromFileSystem(fs, path);
+        var module = Module.FromFileSystem(fs, new NoopLogger(), path);
         Assert.Equal(2, module.Projects.Count());
         Assert.Equal(ProjectType.AutoRestBased, module.Projects.ElementAt(0).Type);
         Assert.Equal(ProjectType.Other, module.Projects.ElementAt(1).Type);
diff --git a/tools/AzDev/Tests/PSTests/InventoryTests.ps1 b/tools/AzDev/Tests/PSTests/InventoryTests.ps1
@@ -5,6 +5,13 @@ BeforeAll {
 }
 
 Describe 'Repo inventory' {
+    It 'Should get all modules and projects' {
+        (Get-DevModule).Count | Should -BeGreaterThan 0
+        (Get-DevProject -Type Wrapper).Count | Should -BeGreaterThan 0
+        (Get-DevProject -Type SdkBased).Count | Should -BeGreaterThan 0
+        (Get-DevProject -Type AutoRestBased).Count | Should -BeGreaterThan 0
+    }
+
     It 'Every autorest project should have either a Wrapper or SdkBased project' {
         (Get-DevModule).Project.Count | Should -BeGreaterThan 0
         Get-DevModule | ForEach-Object{
diff --git a/tools/AzDev/src/Cmdlets/DevCmdletBase.cs b/tools/AzDev/src/Cmdlets/DevCmdletBase.cs
@@ -75,10 +75,19 @@ public void OnImport()
         {
             var contextProvider = new DefaultContextProvider(Constants.DevContextFilePath);
             var codebaseProvider = new DefaultCodebaseProvider(contextProvider);
+
             AzDevModule.SetComponent<IContextProvider>(nameof(IContextProvider), contextProvider);
             AzDevModule.SetComponent<ICodebaseProvider>(nameof(ICodebaseProvider), codebaseProvider);
         }
 
+        protected override void BeginProcessing()
+        {
+            base.BeginProcessing();
+            ILogger logger = new PSCmdletLogger(this);
+            AzDevModule.GetComponent<IContextProvider>(nameof(IContextProvider)).SetLogger(logger);
+            AzDevModule.GetComponent<ICodebaseProvider>(nameof(ICodebaseProvider)).SetLogger(logger);
+        }
+
         protected T SelectFrom<T>(string message, IEnumerable<T> options, bool retryIfInvalid = true)
         {
             if (options == null)
diff --git a/tools/AzDev/src/Models/Inventory/Codebase.cs b/tools/AzDev/src/Models/Inventory/Codebase.cs
@@ -24,14 +24,14 @@ internal class Codebase : IFileSystemBasedModel
         public string Path { get; internal set; }
         public IEnumerable<Module> Modules { get; internal set; }
 
-        internal static Codebase FromFileSystem(IFileSystem fs, string path)
+        internal static Codebase FromFileSystem(IFileSystem fs, ILogger logger, string path)
         {
             return new Codebase()
             {
                 Path = path,
                 Modules = fs.Directory.GetDirectories(path)
                     .Where(dir => !Conventions.IsExcludedModuleDirectory(dir))
-                    .Select(dir => Module.FromFileSystem(fs, dir))
+                    .Select(dir => Module.FromFileSystem(fs, logger, dir))
                     .Where(module => module != null)
                     .ToList()
             };
diff --git a/tools/AzDev/src/Models/Inventory/Module.cs b/tools/AzDev/src/Models/Inventory/Module.cs
@@ -33,15 +33,20 @@ protected Module(IFileSystem fs, string path)
             FileSystem = fs;
             Path = path;
         }
-        internal Module() {}
+        internal Module() { }
 
-        public static Module FromFileSystem(IFileSystem fs, string path)
+        public static Module FromFileSystem(IFileSystem fs, ILogger logger, string path)
         {
             Module m = new Module(fs, path)
             {
                 Name = fs.Path.GetFileName(path),
                 Projects = fs.Directory.GetDirectories(path)
-                    .Where(dir => !Conventions.IsExcludedProjectDirectory(fs, dir, out _))
+                    .Where(dir =>
+                    {
+                        var exclude = Conventions.IsExcludedProjectDirectory(fs, dir, out var r);
+                        if (exclude) logger.Debug($"Excluding project directory '{dir}' because {r}");
+                        return !exclude;
+                    })
                     .Select(dir => Project.FromFileSystem(fs, dir))
                     .ToList()
             };
diff --git a/tools/AzDev/src/Services/Conventions.cs b/tools/AzDev/src/Services/Conventions.cs
@@ -107,11 +107,13 @@ internal static bool IsExcludedProjectDirectory(IFileSystem fs, string path, out
                 return true;
             }
 
-            if (!TryGetOnlyCsprojPath(fs, path, out var _, out var cannotFindCsproj))
+            if (!TryGetOnlyCsprojPath(fs, path, out var _, out var cannotFindCsproj)
+                && !IsAutorestBasedProject(path, out var notAutorestBased))
             {
-                reason = $"Path does not contain a single .csproj file: {cannotFindCsproj}";
+                reason = $"Path does not contain a single .csproj file: {cannotFindCsproj} and is not autorest based: {notAutorestBased}";
                 return true;
             }
+
             reason = null;
             return false;
         }
diff --git a/tools/AzDev/src/Services/DefaultCodebaseProvider.cs b/tools/AzDev/src/Services/DefaultCodebaseProvider.cs
@@ -12,34 +12,47 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using System;
 using System.IO.Abstractions;
 using AzDev.Models.Inventory;
 
 namespace AzDev.Services
 {
     internal class DefaultCodebaseProvider : ICodebaseProvider
     {
-        private IContextProvider _contextProvider;
-        private IFileSystem _fs;
+        private ILogger _logger = new NoopLogger();
+        private readonly IContextProvider _contextProvider;
+        private readonly IFileSystem _fs;
         private Codebase _codebase;
 
         public DefaultCodebaseProvider(IContextProvider contextProvider)
             : this(contextProvider, new FileSystem()) { }
 
         public DefaultCodebaseProvider(IContextProvider contextProvider, IFileSystem fs)
         {
-            _contextProvider = contextProvider;
+            _contextProvider = contextProvider ?? throw new ArgumentNullException(nameof(contextProvider));
             _fs = fs;
         }
 
+        public void SetLogger(ILogger logger)
+        {
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        }
+
         public Codebase GetCodebase()
         {
+            _logger.Verbose("Loading codebase information");
+
             if (_codebase == null)
             {
                 var path = _contextProvider.LoadContext().AzurePowerShellRepositoryRoot;
+                _logger.Verbose($"Codebase path: {path}");
                 var src = _fs.Path.Combine(path, FileOrDirNames.Src);
-                _codebase = _codebase ?? Codebase.FromFileSystem(_fs, src);
+                _codebase = _codebase ?? Codebase.FromFileSystem(_fs, _logger, src);
             }
+
+            _logger.Verbose("Codebase loaded successfully");
+
             return _codebase;
         }
     }
diff --git a/tools/AzDev/src/Services/DefaultContextProvider.cs b/tools/AzDev/src/Services/DefaultContextProvider.cs
@@ -12,6 +12,7 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using System;
 using System.IO.Abstractions;
 using System.Text.Json;
 using AzDev.Models;
@@ -20,6 +21,7 @@ namespace AzDev.Services
 {
     internal class DefaultContextProvider : IContextProvider
     {
+        private ILogger _logger;
         private readonly string _contextFilePath;
         private IFileSystem _fileSystem;
         private DevContext _cachedContext;
@@ -35,10 +37,17 @@ public DefaultContextProvider(string contextFilePath, IFileSystem fileSystem)
             _cachedContext = null;
         }
 
+        public void SetLogger(ILogger logger)
+        {
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        }
+
         public string ContextPath => _contextFilePath;
 
         public DevContext LoadContext()
         {
+            _logger.Verbose($"Loading context from {_contextFilePath}");
+
             if (_cachedContext != null)
             {
                 return _cachedContext;
@@ -52,6 +61,9 @@ public DevContext LoadContext()
 
             string json = _fileSystem.File.ReadAllText(_contextFilePath);
             _cachedContext = JsonSerializer.Deserialize<DevContext>(json);
+
+            _logger.Verbose($"Context loaded successfully");
+
             return _cachedContext;
         }
 
diff --git a/tools/AzDev/src/Services/ICodebaseProvider.cs b/tools/AzDev/src/Services/ICodebaseProvider.cs
@@ -19,5 +19,6 @@ namespace AzDev.Services
     internal interface ICodebaseProvider
     {
         Codebase GetCodebase();
+        void SetLogger(ILogger logger);
     }
 }
diff --git a/tools/AzDev/src/Services/IContextProvider.cs b/tools/AzDev/src/Services/IContextProvider.cs
@@ -21,5 +21,6 @@ internal interface IContextProvider
         string ContextPath { get; }
         DevContext LoadContext();
         void SaveContext(DevContext context);
+        void SetLogger(ILogger logger);
     }
 }
diff --git a/tools/AzDev/src/Services/ILogger.cs b/tools/AzDev/src/Services/ILogger.cs
@@ -0,0 +1,42 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+namespace AzDev.Services
+{
+    /// <summary>
+    /// Provides logging methods that can be used by various components.
+    /// </summary>
+    public interface ILogger
+    {
+        /// <summary>
+        /// Logs a debug message.
+        /// </summary>
+        void Debug(string message);
+
+        /// <summary>
+        /// Logs a verbose message.
+        /// </summary>
+        void Verbose(string message);
+
+        /// <summary>
+        /// Logs a warning message.
+        /// </summary>
+        void Warning(string message);
+
+        /// <summary>
+        /// Logs an informational message.
+        /// </summary>
+        void Information(string message);
+    }
+}
diff --git a/tools/AzDev/src/Services/NoopLogger.cs b/tools/AzDev/src/Services/NoopLogger.cs
@@ -0,0 +1,35 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+namespace AzDev.Services
+{
+    public class NoopLogger : ILogger
+    {
+        public void Debug(string message)
+        {
+        }
+
+        public void Information(string message)
+        {
+        }
+
+        public void Verbose(string message)
+        {
+        }
+
+        public void Warning(string message)
+        {
+        }
+    }
+}
diff --git a/tools/AzDev/src/Services/PSCmdletLogger.cs b/tools/AzDev/src/Services/PSCmdletLogger.cs
@@ -0,0 +1,52 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+using System.Management.Automation;
+
+namespace AzDev.Services
+{
+    /// <summary>
+    /// Implements ILogger using a PSCmdlet instance for logging.
+    /// </summary>
+    public class PSCmdletLogger : ILogger
+    {
+        private readonly PSCmdlet _cmdlet;
+
+        public PSCmdletLogger(PSCmdlet cmdlet)
+        {
+            _cmdlet = cmdlet ?? throw new ArgumentNullException(nameof(cmdlet));
+        }
+
+        public void Debug(string message)
+        {
+            _cmdlet.WriteDebug(message);
+        }
+
+        public void Verbose(string message)
+        {
+            _cmdlet.WriteVerbose(message);
+        }
+
+        public void Warning(string message)
+        {
+            _cmdlet.WriteWarning(message);
+        }
+
+        public void Information(string message)
+        {
+            _cmdlet.WriteInformation(new InformationRecord(message, "AzDev"));
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -75,10 +75,19 @@ public void OnImport()`
`75`	`75`	`{`
`76`	`76`	`var contextProvider = new DefaultContextProvider(Constants.DevContextFilePath);`
`77`	`77`	`var codebaseProvider = new DefaultCodebaseProvider(contextProvider);`
	`78`	`+`
`78`	`79`	`AzDevModule.SetComponent<IContextProvider>(nameof(IContextProvider), contextProvider);`
`79`	`80`	`AzDevModule.SetComponent<ICodebaseProvider>(nameof(ICodebaseProvider), codebaseProvider);`
`80`	`81`	`}`
`81`	`82`
	`83`	`+ protected override void BeginProcessing()`
	`84`	`+ {`
	`85`	`+ base.BeginProcessing();`
	`86`	`+ ILogger logger = new PSCmdletLogger(this);`
	`87`	`+ AzDevModule.GetComponent<IContextProvider>(nameof(IContextProvider)).SetLogger(logger);`
	`88`	`+ AzDevModule.GetComponent<ICodebaseProvider>(nameof(ICodebaseProvider)).SetLogger(logger);`
	`89`	`+ }`
	`90`	`+`
`82`	`91`	`protected T SelectFrom<T>(string message, IEnumerable<T> options, bool retryIfInvalid = true)`
`83`	`92`	`{`
`84`	`93`	`if (options == null)`
Original file line number	Diff line number	Diff line change
`@@ -107,11 +107,13 @@ internal static bool IsExcludedProjectDirectory(IFileSystem fs, string path, out`
`107`	`107`	`return true;`
`108`	`108`	`}`
`109`	`109`
`110`		`- if (!TryGetOnlyCsprojPath(fs, path, out var _, out var cannotFindCsproj))`
	`110`	`+ if (!TryGetOnlyCsprojPath(fs, path, out var _, out var cannotFindCsproj)`
	`111`	`+ && !IsAutorestBasedProject(path, out var notAutorestBased))`
`111`	`112`	`{`
`112`		`- reason = $"Path does not contain a single .csproj file: {cannotFindCsproj}";`
	`113`	`+ reason = $"Path does not contain a single .csproj file: {cannotFindCsproj} and is not autorest based: {notAutorestBased}";`
`113`	`114`	`return true;`
`114`	`115`	`}`
	`116`	`+`
`115`	`117`	`reason = null;`
`116`	`118`	`return false;`
`117`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,34 +12,47 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
	`15`	`+using System;`
`15`	`16`	`using System.IO.Abstractions;`
`16`	`17`	`using AzDev.Models.Inventory;`
`17`	`18`
`18`	`19`	`namespace AzDev.Services`
`19`	`20`	`{`
`20`	`21`	`internal class DefaultCodebaseProvider : ICodebaseProvider`
`21`	`22`	`{`
`22`		`- private IContextProvider _contextProvider;`
`23`		`- private IFileSystem _fs;`
	`23`	`+ private ILogger _logger = new NoopLogger();`
	`24`	`+ private readonly IContextProvider _contextProvider;`
	`25`	`+ private readonly IFileSystem _fs;`
`24`	`26`	`private Codebase _codebase;`
`25`	`27`
`26`	`28`	`public DefaultCodebaseProvider(IContextProvider contextProvider)`
`27`	`29`	`: this(contextProvider, new FileSystem()) { }`
`28`	`30`
`29`	`31`	`public DefaultCodebaseProvider(IContextProvider contextProvider, IFileSystem fs)`
`30`	`32`	`{`
`31`		`- _contextProvider = contextProvider;`
	`33`	`+ _contextProvider = contextProvider ?? throw new ArgumentNullException(nameof(contextProvider));`
`32`	`34`	`_fs = fs;`
`33`	`35`	`}`
`34`	`36`
	`37`	`+ public void SetLogger(ILogger logger)`
	`38`	`+ {`
	`39`	`+ _logger = logger ?? throw new ArgumentNullException(nameof(logger));`
	`40`	`+ }`
	`41`	`+`
`35`	`42`	`public Codebase GetCodebase()`
`36`	`43`	`{`
	`44`	`+ _logger.Verbose("Loading codebase information");`
	`45`	`+`
`37`	`46`	`if (_codebase == null)`
`38`	`47`	`{`
`39`	`48`	`var path = _contextProvider.LoadContext().AzurePowerShellRepositoryRoot;`
	`49`	`+ _logger.Verbose($"Codebase path: {path}");`
`40`	`50`	`var src = _fs.Path.Combine(path, FileOrDirNames.Src);`
`41`		`- _codebase = _codebase ?? Codebase.FromFileSystem(_fs, src);`
	`51`	`+ _codebase = _codebase ?? Codebase.FromFileSystem(_fs, _logger, src);`
`42`	`52`	`}`
	`53`	`+`
	`54`	`+ _logger.Verbose("Codebase loaded successfully");`
	`55`	`+`
`43`	`56`	`return _codebase;`
`44`	`57`	`}`
`45`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,6 @@ namespace AzDev.Services`
`19`	`19`	`internal interface ICodebaseProvider`
`20`	`20`	`{`
`21`	`21`	`Codebase GetCodebase();`
	`22`	`+ void SetLogger(ILogger logger);`
`22`	`23`	`}`
`23`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,6 @@ internal interface IContextProvider`
`21`	`21`	`string ContextPath { get; }`
`22`	`22`	`DevContext LoadContext();`
`23`	`23`	`void SaveContext(DevContext context);`
	`24`	`+ void SetLogger(ILogger logger);`
`24`	`25`	`}`
`25`	`26`	`}`