add generated code attribute/region to the generated code

xerxesb · May 3, 2010 · 310f3ea · 310f3ea
1 parent 7f75fe4
commit 310f3ea
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 8 deletions.
diff --git a/Generator/CodeDomHelper.cs b/Generator/CodeDomHelper.cs
@@ -3,6 +3,7 @@
 using System.CodeDom.Compiler;
 using System.Globalization;
 using System.Reflection;
+using System.Runtime.CompilerServices;
 
 namespace TechTalk.SpecFlow.Generator
 {
@@ -114,5 +115,48 @@ public void AddDisableSourceLinePragmaStatement(CodeStatementCollection statemen
                     break;
             }
         }
+
+        public CodeStatement GetStartRegionStatement(string regionText)
+        {
+            switch (TargetLanguage)
+            {
+                case GenerationTargetLanguage.CSharp:
+                    return new CodeSnippetStatement("#region " + regionText);
+                case GenerationTargetLanguage.VB:
+                    return new CodeSnippetStatement("#Region \"" + regionText + "\"");
+            }
+            return new CodeCommentStatement("#region " + regionText);
+        }
+
+        public CodeStatement GetEndRegionStatement()
+        {
+            switch (TargetLanguage)
+            {
+                case GenerationTargetLanguage.CSharp:
+                    return new CodeSnippetStatement("#endregion");
+                case GenerationTargetLanguage.VB:
+                    return new CodeSnippetStatement("#End Region");
+            }
+            return new CodeCommentStatement("#endregion");
+        }
+
+        private Version GetCurrentSpecFlowVersion()
+        {
+            return Assembly.GetExecutingAssembly().GetName().Version;
+        }
+
+        public CodeTypeDeclaration CreateGeneratedTypeDeclaration(string className)
+        {
+            var result = new CodeTypeDeclaration(className);
+            result.CustomAttributes.Add(
+                new CodeAttributeDeclaration(
+                    new CodeTypeReference(typeof(GeneratedCodeAttribute)),
+                    new CodeAttributeArgument(new CodePrimitiveExpression("TechTalk.SpecFlow")),
+                    new CodeAttributeArgument(new CodePrimitiveExpression(GetCurrentSpecFlowVersion().ToString()))));
+            result.CustomAttributes.Add(
+                new CodeAttributeDeclaration(
+                    new CodeTypeReference(typeof(CompilerGeneratedAttribute))));
+            return result;
+        }
     }
 }
diff --git a/Generator/SpecFlowGenerator.cs b/Generator/SpecFlowGenerator.cs
@@ -115,26 +115,27 @@ public void GenerateTestFile(SpecFlowFeatureFile featureFile, CodeDomProvider co
         {
             outputWriter = new HackedWriter(outputWriter);
 
-            var codeNamespace = GenerateTestFileCode(featureFile, inputReader, codeProvider);
+            CodeDomHelper codeDomHelper = new CodeDomHelper(codeProvider);
+
+            var codeNamespace = GenerateTestFileCode(featureFile, inputReader, codeProvider, codeDomHelper);
             var options = new CodeGeneratorOptions
                 {
                     BracingStyle = "C"
                 };
 
-            AddSpecFlowHeader(codeProvider, outputWriter);
+            AddSpecFlowHeader(codeProvider, outputWriter, codeDomHelper);
             codeProvider.GenerateCodeFromNamespace(codeNamespace, outputWriter, options);
+            AddSpecFlowFooter(codeProvider, outputWriter, codeDomHelper);
             outputWriter.Flush();
         }
 
-        public CodeNamespace GenerateTestFileCode(SpecFlowFeatureFile featureFile, TextReader inputReader, CodeDomProvider codeProvider)
+        public CodeNamespace GenerateTestFileCode(SpecFlowFeatureFile featureFile, TextReader inputReader, CodeDomProvider codeProvider, CodeDomHelper codeDomHelper)
         {
             string targetNamespace = GetTargetNamespace(featureFile);
 
             SpecFlowLangParser parser = new SpecFlowLangParser(project.GeneratorConfiguration.FeatureLanguage);
             Feature feature = parser.Parse(inputReader, featureFile.GetFullPath(project));
 
-            CodeDomHelper codeDomHelper = new CodeDomHelper(codeProvider);
-
             IUnitTestGeneratorProvider generatorProvider = ConfigurationServices.CreateInstance<IUnitTestGeneratorProvider>(project.GeneratorConfiguration.GeneratorUnitTestProviderType);
             codeDomHelper.InjectIfRequired(generatorProvider);
 
@@ -168,7 +169,7 @@ private string GetTargetNamespace(SpecFlowFeatureFile featureFile)
             return targetNamespace;
         }
 
-        private void AddSpecFlowHeader(CodeDomProvider codeProvider, TextWriter outputWriter)
+        private void AddSpecFlowHeader(CodeDomProvider codeProvider, TextWriter outputWriter, CodeDomHelper codeDomHelper)
         {
             var specFlowHeaderTemplate = @"------------------------------------------------------------------------------
  <auto-generated>
@@ -191,6 +192,13 @@ the code is regenerated.
             {
                 codeProvider.GenerateCodeFromStatement(new CodeCommentStatement(line), outputWriter, null);
             }
+
+            codeProvider.GenerateCodeFromStatement(codeDomHelper.GetStartRegionStatement("Designer generated code"), outputWriter, null);
+        }
+
+        private void AddSpecFlowFooter(CodeDomProvider codeProvider, TextWriter outputWriter, CodeDomHelper codeDomHelper)
+        {
+            codeProvider.GenerateCodeFromStatement(codeDomHelper.GetEndRegionStatement(), outputWriter, null);
         }
 
         public Version GetCurrentSpecFlowVersion()

diff --git a/Generator/SpecFlowUnitTestConverter.cs b/Generator/SpecFlowUnitTestConverter.cs
@@ -53,7 +53,7 @@ public CodeNamespace GenerateUnitTestFixture(Feature feature, string testClassNa
 
             codeNamespace.Imports.Add(new CodeNamespaceImport(SPECFLOW_NAMESPACE));
 
-            var testType = new CodeTypeDeclaration(testClassName);
+            var testType = codeDomHelper.CreateGeneratedTypeDeclaration(testClassName);
             testType.IsPartial = true;
             testType.TypeAttributes |= TypeAttributes.Public;
             codeNamespace.Types.Add(testType);

diff --git a/Generator/UnitTestProvider/XUnitTestGeneratorProvider.cs b/Generator/UnitTestProvider/XUnitTestGeneratorProvider.cs
@@ -41,7 +41,7 @@ public void SetTestFixtureSetup(CodeMemberMethod fixtureSetupMethod)
 
             fixtureSetupMethod.Attributes |= MemberAttributes.Static;
 
-            _currentFixtureTypeDeclaration = new CodeTypeDeclaration("FixtureData");
+            _currentFixtureTypeDeclaration = CodeDomHelper.CreateGeneratedTypeDeclaration("FixtureData");
             _currentTestTypeDeclaration.Members.Add(_currentFixtureTypeDeclaration);
 
             var fixtureDataType = 

diff --git a/Tests/FeatureTests/CallingStepsFromStepDefinitions/CallingStepsFromStepDefinition.feature.cs b/Tests/FeatureTests/CallingStepsFromStepDefinitions/CallingStepsFromStepDefinition.feature.cs
diff --git a/Tests/FeatureTests/ContextInjection/ContextInjection.feature.cs b/Tests/FeatureTests/ContextInjection/ContextInjection.feature.cs
diff --git a/Tests/FeatureTests/ExternalSteps/ExternalSteps.feature.cs b/Tests/FeatureTests/ExternalSteps/ExternalSteps.feature.cs
diff --git a/Tests/FeatureTests/StepArgumentTransfomation/StepArgumentTransformation.feature.cs b/Tests/FeatureTests/StepArgumentTransfomation/StepArgumentTransformation.feature.cs
diff --git a/Tests/RuntimeTests/ExecutionTestBase.cs b/Tests/RuntimeTests/ExecutionTestBase.cs
@@ -187,6 +187,8 @@ private object CompileAndCreateTest(string fileName, Feature feature)
             compilerParameters.GenerateInMemory = true;
             compilerParameters.TempFiles.KeepFiles = true;
 
+            compilerParameters.ReferencedAssemblies.Add(
+                TestFileHelper.GetAssemblyPath(typeof (GeneratedCodeAttribute))); //System
             compilerParameters.ReferencedAssemblies.Add(
                 TestFileHelper.GetAssemblyPath(typeof (TestAttribute))); //NUnit
             compilerParameters.ReferencedAssemblies.Add(

diff --git a/changelog.txt b/changelog.txt
@@ -14,6 +14,8 @@ New features:
 + Support for xUnit
 + Single installer for Visual Studio 2008 and 2010 (Issue 6, 10, 11)
 + SpecFlow Reporting doesn't work with Firefox (Issue 31)
++ Place GeneratedCodeAttribute and 'Designer generated code' region on generated code to 
+  avoid having this code parsed by code analysis. (Issue 33)
 
 1.2.0 - 2009/11/25