Improve processing of custom attributes (#173)

(cherry picked from commit 79db556)

Author: josesimoes

MetadataProcessor.Shared/Extensions/TypeReferenceExtensions.cs

@@ -4,15 +4,28 @@
 //
 
 using Mono.Cecil;
+using System.Collections.Generic;
+using System.Linq;
 using System.Text;
 
 namespace nanoFramework.Tools.MetadataProcessor.Core.Extensions
 {
     internal static class TypeReferenceExtensions
     {
+        internal static readonly List<string> NameSpacesToExclude = new List<string>
+        {
+            "System.Diagnostics.CodeAnalysis"
+        };
+
         public static bool IsToInclude(this TypeReference value)
         {
-            return !nanoTablesContext.IgnoringAttributes.Contains(value.FullName);
+            // check list of known attributes to ignore
+            bool ignoreFromList = nanoTablesContext.IgnoringAttributes.Contains(value.FullName);
+
+            // is this attribute in the list of namespaces to exclude
+            bool ignoreFromCodeAnalysis = NameSpacesToExclude.Any(ns => value.FullName.StartsWith(ns));
+
+            return !(ignoreFromList || ignoreFromCodeAnalysis);
         }
 
         public static string TypeSignatureAsString(this TypeReference type)

MetadataProcessor.Tests/Core/Tables/nanoAttributesTableTests.cs

@@ -5,9 +5,12 @@
 
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Mono.Cecil;
+using nanoFramework.Tools.MetadataProcessor.Core.Extensions;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
+using CustomAttribute = Mono.Cecil.CustomAttribute;
 
 namespace nanoFramework.Tools.MetadataProcessor.Tests.Core.Tables
 {
@@ -167,7 +170,28 @@ public void RemoveUnusedItems_MethodAttributesTest()
                 bytesWritten,
                 String.Join(", ", bytesWritten.Select(i => i.ToString("X"))));
         }
-    }
 
+        [TestMethod]
+        public void TestCodeAnalysisAttributes()
+        {
+            var assemblyDefinition = TestObjectHelper.GetTestNFAppAssemblyDefinitionWithLoadHints();
+            var assemblyBuilder = new nanoAssemblyBuilder(assemblyDefinition, new List<string>(), false);
+
+            using (var stream = File.Open(Path.GetTempFileName(), FileMode.Create, FileAccess.ReadWrite))
+            using (var writer = new BinaryWriter(stream))
+            {
+                // test
+                assemblyBuilder.Write(nanoBinaryWriter.CreateLittleEndianBinaryWriter(writer));
+            }
+
+            // minimize the assembly, following the first pass
+            assemblyBuilder.Minimize();
 
+            // Assert that TypeReferencesTable doesn't contain any of the items in NameSpacesToExclude
+            foreach (var item in assemblyBuilder.TablesContext.TypeReferencesTable.Items)
+            {
+                Assert.IsFalse(TypeReferenceExtensions.NameSpacesToExclude.Any(ns => item.FullName.StartsWith(ns)), $"TypeRef table includes {item.FullName} when it shouldn't.");
+            }
+        }
+    }
 }

MetadataProcessor.Tests/TestNFApp/ClassWithNullAttribs.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TestNFApp
+{
+    public class ClassWithNullAttribs
+    {
+        [DoesNotReturn]
+        public int MethodDecoratedWithDoesNotReturn()
+        {
+            throw new Exception();
+        }
+
+        public string MethoWIthParamNotNullAttrib([NotNull] string value)
+        {
+            return value;
+        }
+    }
+}

MetadataProcessor.Tests/TestNFApp/Program.cs

@@ -75,6 +75,9 @@ public static void Main()
                     break;
             }
 
+            // null attributes tests
+            _ = new ClassWithNullAttribs();
+
             Debug.WriteLine("Exiting TestNFApp");
         }
 

MetadataProcessor.Tests/TestNFApp/TestNFApp.nfproj

@@ -19,6 +19,7 @@
   <Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.props" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.props')" />
   <ItemGroup>
     <Compile Include="AuthorAttribute.cs" />
+    <Compile Include="ClassWithNullAttribs.cs" />
     <Compile Include="DataRowAttribute.cs" />
     <Compile Include="DummyCustomAttribute1.cs" />
     <Compile Include="DummyCustomAttribute2.cs" />

MetadataProcessor.Tests/TestObjectHelper.cs

@@ -195,6 +195,21 @@ public static AssemblyDefinition GetTestNFAppAssemblyDefinition()
 
             return ret;
         }
+
+        public static AssemblyDefinition GetTestNFAppAssemblyDefinitionWithLoadHints()
+        {
+            IDictionary<string, string> loadHints = new Dictionary<string, string>(StringComparer.Ordinal)
+            {
+                ["mscorlib"] = GetmscorlibAssemblyDefinition().MainModule.FileName,
+                ["TestNFClassLibrary"] = GetTestNFClassLibraryDefinition().MainModule.FileName
+            };
+
+            return AssemblyDefinition.ReadAssembly(
+                TestNFAppFullPath,
+                new ReaderParameters { AssemblyResolver = new LoadHintsAssemblyResolver(loadHints) });
+        }
+
+
         public static AssemblyDefinition GetTestNFClassLibraryDefinition()
         {
             AssemblyDefinition ret = null;