Merge pull request #1826 from TypeCobolTeam/1825_SupportExternalAnalyzers

WI #1825 Find and load analyzers from external assemblies

Author: fm-117

CLI/src/CLI.cs

@@ -112,6 +112,9 @@ private ReturnCode Compile()
             var analyzerProvider = new CompositeAnalyzerProvider();
             var reports = RegisterAnalyzers(analyzerProvider);
 
+            //Add external analyzers
+            analyzerProvider.AddCustomProviders(_configuration.CustomAnalyzerFiles);
+
             //Normalize TypeCobolOptions, the parser does not need to go beyond SemanticCheck for the first phase
             var typeCobolOptions = new TypeCobolOptions(_configuration);
             if (_configuration.ExecToStep > ExecutionStep.SemanticCheck)

CLI/test/CLITest.cs

@@ -330,6 +330,15 @@ public void TestRDZFormatInputEncodings()
             CLITestHelper.Test("rdzformat_inputencoding_wrong", ReturnCode.Success);
             CLITestHelper.Test("rdzformat_inputencoding_good", ReturnCode.Success);
         }
+
+        /// <summary>
+        /// Test custom analyzers defined in TypeCobol.Analysis.Test.dll.
+        /// </summary>
+        [TestMethod]
+        public void TestCustomAnalyzers()
+        {
+            CLITestHelper.Test("custom_analyzers", ReturnCode.Warning);
+        }
     }
 
     public class CLITestHelper {

CLI/test/ressources/custom_analyzers/CLIArguments.txt

@@ -0,0 +1 @@
+-i input\CustomAnalyzers.rdz.tcbl -o output\CustomAnalyzers.cbl -d output\errors.txt -ca "..\..\TypeCobol.Analysis.Test.dll" --exectostep=QualityCheck

CLI/test/ressources/custom_analyzers/input/CustomAnalyzers.rdz.tcbl

@@ -0,0 +1,10 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. DVZZMFT0.
+       DATA DIVISION.
+       WORKING-STORAGE SECTION.
+       01 var1 PIC X.
+       PROCEDURE DIVISION.
+          MOVE 'A' TO var1
+          GOBACK
+          .
+       END PROGRAM DVZZMFT0.

CLI/test/ressources/custom_analyzers/output_expected/errors.txt

@@ -0,0 +1,5 @@
+ReturnCode=Warning_
+3 errors in "input\CustomAnalyzers.rdz.tcbl":
+Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': starting AST building...
+Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummySyntaxDrivenAnalyzer': finished AST building.
+Line 0[0,0] <45, Warning, General> - Info: Analyzer 'DummyASTAnalyzer': visiting source file.

TypeCobol.Analysis.Test/CustomAnalyzers/Analyzers.cs

@@ -0,0 +1,57 @@
+using TypeCobol.Compiler.CodeElements;
+using TypeCobol.Compiler.CupParser.NodeBuilder;
+using TypeCobol.Compiler.Diagnostics;
+using TypeCobol.Compiler.Nodes;
+
+namespace TypeCobol.Analysis.Test.CustomAnalyzers
+{
+    /// <summary>
+    /// Simple SyntaxDrivenAnalyzer to demonstrate dynamic load and use during AST building
+    /// </summary>
+    internal class DummySyntaxDrivenAnalyzer : SyntaxDrivenAnalyzerBase
+    {
+        public DummySyntaxDrivenAnalyzer(string identifier)
+            : base(identifier)
+        {
+
+        }
+
+        public override object GetResult()
+        {
+            return null;
+        }
+
+        public override void StartCobolProgram(ProgramIdentification programIdentification, LibraryCopyCodeElement libraryCopy)
+        {
+            AddDiagnostic(new Diagnostic(MessageCode.Info, 0, 0, 0, $"Analyzer '{Identifier}': starting AST building..."));
+        }
+
+        public override void EndCobolProgram(ProgramEnd end)
+        {
+            AddDiagnostic(new Diagnostic(MessageCode.Info, 0, 0, 0, $"Analyzer '{Identifier}': finished AST building."));
+        }
+    }
+
+    /// <summary>
+    /// Simple ASTAnalyzer to demonstrate dynamic load and use in QualityCheck
+    /// </summary>
+    internal class DummyASTAnalyzer : ASTAnalyzerBase
+    {
+        public DummyASTAnalyzer(string identifier)
+            : base(identifier)
+        {
+
+        }
+
+        public override object GetResult()
+        {
+            return null;
+        }
+
+        public override bool Visit(SourceFile sourceFile)
+        {
+            AddDiagnostic(new Diagnostic(MessageCode.Info, 0, 0, 0, $"Analyzer '{Identifier}': visiting source file."));
+            return false;
+        }
+    }
+}

TypeCobol.Analysis.Test/CustomAnalyzers/TestAnalyzerProvider.cs

@@ -0,0 +1,21 @@
+using TypeCobol.Compiler.Directives;
+using TypeCobol.Compiler.Text;
+
+namespace TypeCobol.Analysis.Test.CustomAnalyzers
+{
+    /// <summary>
+    /// This provider is loaded and called in CLI.Test, see TestCustomAnalyzers unit test.
+    /// </summary>
+    public class TestAnalyzerProvider : IAnalyzerProvider
+    {
+        public ISyntaxDrivenAnalyzer[] CreateSyntaxDrivenAnalyzers(TypeCobolOptions options, TextSourceInfo textSourceInfo)
+        {
+            return new ISyntaxDrivenAnalyzer[] { new DummySyntaxDrivenAnalyzer(nameof(DummySyntaxDrivenAnalyzer)) };
+        }
+
+        public IASTAnalyzer[] CreateASTAnalyzers(TypeCobolOptions options)
+        {
+            return new IASTAnalyzer[] { new DummyASTAnalyzer(nameof(DummyASTAnalyzer)) };
+        }
+    }
+}

TypeCobol.Analysis.Test/TypeCobol.Analysis.Test.csproj

@@ -38,6 +38,8 @@
     <Compile Include="DfaBuildUseAndDefListTest.cs" />
     <Compile Include="DfaCallPgmReport.cs" />
     <Compile Include="BasicDfaSamplesTest.cs" />
+    <Compile Include="CustomAnalyzers\TestAnalyzerProvider.cs" />
+    <Compile Include="CustomAnalyzers\Analyzers.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>

TypeCobol.LanguageServer/Workspace.cs

@@ -506,9 +506,10 @@ public void DidChangeConfigurationParams(IEnumerable<string> arguments)
 
             var typeCobolOptions = new TypeCobolOptions(Configuration);
 
-            //Configure CFG/DFA analyzer
+            //Configure CFG/DFA analyzer + external analyzers if any
             var analyzerProvider = new CompositeAnalyzerProvider();
             analyzerProvider.AddActivator((o, t) => CfgDfaAnalyzerFactory.CreateCfgAnalyzer("cfg-dfa", Configuration.CfgBuildingMode));
+            analyzerProvider.AddCustomProviders(Configuration.CustomAnalyzerFiles);
 
             CompilationProject = new CompilationProject(_workspaceName, _rootDirectoryFullName, Helpers.DEFAULT_EXTENSIONS, Configuration.Format, typeCobolOptions, analyzerProvider);
 

TypeCobol/Analysis/AnalyzerProvider.cs

@@ -70,7 +70,10 @@ private TAnalyzer[] Concat<TAnalyzer>(TAnalyzer[] fromBase, Func<IAnalyzerProvid
         {
             if (_providers != null && _providers.Count > 0)
             {
-                var result = _providers.SelectMany(selector);
+                var result = _providers
+                    .Select(selector) //from provider to analyzers
+                    .Where(a => a != null) //providers may return null arrays so filter them out
+                    .SelectMany(a => a); //join all arrays into a single IEnumerable
                 if (fromBase != null)
                 {
                     result = fromBase.Concat(result);