Exclude Feature or Scenario by Tag

.gitignore

@@ -3,6 +3,7 @@
 *.DS_Store
 
 #Visual Studio files
+.vs
 *.[Oo]bj
 *.user
 *.aps

src/Pickles/Pickles.MSBuild/Pickles.cs

@@ -51,6 +51,8 @@ public class Pickles : Task
 
         public string EnableComments { get; set; }
 
+        public string IgnoreTag { get; set; }
+
         public override bool Execute()
         {
             try
@@ -113,6 +115,11 @@ private void CaptureConfiguration(IConfiguration configuration, IFileSystem file
             {
                 configuration.DocumentationFormat = (DocumentationFormat)Enum.Parse(typeof(DocumentationFormat), this.DocumentationFormat, true);
             }
+
+            if (!string.IsNullOrEmpty(this.IgnoreTag))
+            {
+                configuration.IgnoreTag = this.IgnoreTag;
+            }
 
             bool shouldEnableExperimentalFeatures;
 

src/Pickles/Pickles.ObjectModel/IConfiguration.cs

@@ -47,6 +47,8 @@ public interface IConfiguration
 
         bool ShouldIncludeExperimentalFeatures { get; }
 
+        string IgnoreTag { get; set; }
+
         void AddTestResultFile(FileInfoBase fileInfoBase);
 
         void AddTestResultFiles(IEnumerable<FileInfoBase> fileInfoBases);

src/Pickles/Pickles.PowerShell/Pickle_Features.cs

@@ -61,6 +61,9 @@ public class Pickle_Features : PSCmdlet
         [Parameter(HelpMessage = CommandLineArgumentParser.HelpEnableComments, Mandatory = false)]
         public string EnableComments { get; set; }
 
+        [Parameter(HelpMessage = CommandLineArgumentParser.HelpIgnoreTag, Mandatory = false)]
+        public string IgnoreTag { get; set; }
+
         protected override void ProcessRecord()
         {
             var builder = new ContainerBuilder();
@@ -120,6 +123,11 @@ private void ParseParameters(IConfiguration configuration, IFileSystem fileSyste
                 configuration.EnableExperimentalFeatures();
             }
 
+            if (!string.IsNullOrEmpty(this.IgnoreTag))
+            {
+                configuration.IgnoreTag = this.IgnoreTag;
+            }
+
             bool shouldEnableComments;
 
             if (bool.TryParse(this.EnableComments, out shouldEnableComments))

src/Pickles/Pickles.Test/WhenParsingCommandLineArguments.cs

@@ -487,5 +487,19 @@ public void ThenSetsLanguageToEnglishByDefault()
 
             Check.That(configuration.Language).IsEqualTo("en");
         }
+
+        [Test]
+        public void ThenCanParseIgnoreTagSuccessfully()
+        {
+            var ignoreTag = "ignore-tag";
+            var args = new[] { $@"-ignoreTag={ignoreTag}" };
+
+            var configuration = new Configuration();
+            var commandLineArgumentParser = new CommandLineArgumentParser(FileSystem);
+            bool shouldContinue = commandLineArgumentParser.Parse(args, configuration, TextWriter.Null);
+
+            Check.That(shouldContinue).IsTrue();
+            Check.That(configuration.IgnoreTag).IsEqualTo(ignoreTag);
+        }
     }
 }

src/Pickles/Pickles.Test/WhenParsingFeatureFiles.cs

@@ -19,6 +19,7 @@
 //  --------------------------------------------------------------------------------------------------------------------
 
 using System;
+using System.IO.Abstractions;
 using System.Linq;
 
 using Autofac;
@@ -395,5 +396,100 @@ Then I should see that this thing happens
         }
 
 
+
+        [Test]
+        public void Then_can_parse_and_ignore_feature_with_tag_in_configuration_ignore_tag()
+        {
+            var ignoreTag = "ignore-tag";
+            string featureText =
+                $@"# ignore this comment
+@feature-tag @{ignoreTag}
+Feature: Test
+    In order to do something
+    As a user
+    I want to run this scenario
+
+    @scenario-tag-1 @scenario-tag-2
+  Scenario: A scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens";
+
+            var parser = new FeatureParser(Container.Resolve<IFileSystem>(), new Configuration { IgnoreTag = ignoreTag });
+            var feature = parser.Parse(new StringReader(featureText));
+
+            Check.That(feature).IsNull();
+        }
+
+        [Test]
+        public void Then_can_parse_and_ignore_scenario_with_tag_in_configuration_ignore_tag()
+        {
+            var ignoreTag = "ignore-tag";
+            string featureText =
+                $@"# ignore this comment
+@feature-tag
+Feature: Test
+    In order to do something
+    As a user
+    I want to run this scenario
+
+    @scenario-tag-1 @scenario-tag-2
+  Scenario: A scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens
+
+    @scenario-tag-1 @scenario-tag-2 @{ignoreTag}
+  Scenario: B scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens
+
+    @scenario-tag-1 @scenario-tag-2
+  Scenario: C scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens";
+
+            var parser = new FeatureParser(Container.Resolve<IFileSystem>(), new Configuration { IgnoreTag = ignoreTag });
+            var feature = parser.Parse(new StringReader(featureText));
+
+            Check.That(feature.FeatureElements.Count).IsEqualTo(2);
+            Check.That(feature.FeatureElements.FirstOrDefault(fe => fe.Name == "A scenario")).IsNotNull();
+            Check.That(feature.FeatureElements.FirstOrDefault(fe => fe.Name == "B scenario")).IsNull();
+            Check.That(feature.FeatureElements.FirstOrDefault(fe => fe.Name == "C scenario")).IsNotNull();
+        }
+
+        [Test]
+        public void Then_can_parse_and_ignore_scenario_with_tag_in_configuration_ignore_tag_and_keep_feature()
+        {
+            var ignoreTag = "ignore-tag";
+            string featureText =
+                $@"# ignore this comment
+@feature-tag
+Feature: Test
+    In order to do something
+    As a user
+    I want to run this scenario
+
+    @scenario-tag-1 @scenario-tag-2 @{ignoreTag}
+  Scenario: A scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens
+
+    @scenario-tag-1 @scenario-tag-2 @{ignoreTag}
+  Scenario: B scenario
+    Given some feature
+    When it runs
+    Then I should see that this thing happens";
+
+            var parser = new FeatureParser(Container.Resolve<IFileSystem>(), new Configuration { IgnoreTag = ignoreTag });
+            var feature = parser.Parse(new StringReader(featureText));
+
+            Check.That(feature).IsNotNull();
+            Check.That(feature.FeatureElements).IsEmpty();
+        }
     }
 }
+

src/Pickles/Pickles/CommandLineArgumentParser.cs

@@ -40,6 +40,7 @@ public class CommandLineArgumentParser
         public const string HelpTestResultsFormat = "the format of the linked test results (nunit|nunit3|xunit|xunit2|mstest |cucumberjson|specrun|vstest)";
         public const string HelpIncludeExperimentalFeatures = "whether to include experimental features";
         public const string HelpEnableComments = "whether to enable comments in the output";
+        public const string HelpIgnoreTag = "tag used for ignore feature or scenario";
 
         public const string HelpTestResultsFile =
             "the path to the linked test results file (can be a semicolon-separated list of files)";
@@ -58,6 +59,7 @@ public class CommandLineArgumentParser
         private bool versionRequested;
         private bool includeExperimentalFeatures;
         private string enableCommentsValue;
+        private string ignoreTag;
 
         public CommandLineArgumentParser(IFileSystem fileSystem)
         {
@@ -75,7 +77,8 @@ public CommandLineArgumentParser(IFileSystem fileSystem)
                 { "v|version", v => this.versionRequested = v != null },
                 { "h|?|help", v => this.helpRequested = v != null },
                 { "exp|include-experimental-features", HelpIncludeExperimentalFeatures, v => this.includeExperimentalFeatures = v != null },
-                { "cmt|enableComments=", HelpEnableComments, v => this.enableCommentsValue = v }
+                { "cmt|enableComments=", HelpEnableComments, v => this.enableCommentsValue = v },
+                { "it|ignoreTag=", HelpIgnoreTag, v => this.ignoreTag = v }
             };
         }
 
@@ -148,6 +151,11 @@ public bool Parse(string[] args, IConfiguration configuration, TextWriter stdout
                 configuration.EnableExperimentalFeatures();
             }
 
+            if (!string.IsNullOrEmpty(this.ignoreTag))
+            {
+                configuration.IgnoreTag = this.ignoreTag;
+            }
+
             bool enableComments;
 
             if (bool.TryParse(this.enableCommentsValue, out enableComments) && enableComments == false)

src/Pickles/Pickles/Configuration.cs

@@ -107,6 +107,8 @@ public void AddTestResultFiles(IEnumerable<FileInfoBase> fileInfoBases)
             }
         }
 
+        public string IgnoreTag { get; set; }
+
         private void AddTestResultFileIfItExists(FileInfoBase fileInfoBase)
         {
             if (fileInfoBase.Exists)

src/Pickles/Pickles/ConfigurationReporter.cs

@@ -35,6 +35,7 @@ public void ReportOn(IConfiguration configuration, Action<string> writeToLog)
             writeToLog($"Language                       : {configuration.Language}");
             writeToLog($"Incorporate Test Results?      : {(configuration.HasTestResults ? "Yes" : "No")}");
             writeToLog($"Include Experimental Features? : {(configuration.ShouldIncludeExperimentalFeatures ? "Yes" : "No")}");
+            writeToLog($"Ignore Tag                       : {configuration.IgnoreTag}");
 
             if (configuration.HasTestResults)
             {

src/Pickles/Pickles/DirectoryCrawler/DirectoryTreeCrawler.cs

@@ -106,7 +106,8 @@ private bool CollectFiles(DirectoryInfoBase directory, INode rootNode, Tree tree
             foreach (FileInfoBase file in directory.GetFiles().Where(file => this.relevantFileDetector.IsRelevant(file)))
             {
                 INode node = this.featureNodeFactory.Create(rootNode.OriginalLocation, file);
-                collectedNodes.Add(node);
+                if(node != null)
+                    collectedNodes.Add(node);
             }
 
             foreach (var node in OrderFileNodes(collectedNodes))

src/Pickles/Pickles/DirectoryCrawler/FeatureNodeFactory.cs

@@ -23,6 +23,7 @@
 using System.Xml.Linq;
 
 using PicklesDoc.Pickles.DocumentationBuilders.Html;
+using PicklesDoc.Pickles.DocumentationBuilders.Word.TableOfContentsAdder;
 using PicklesDoc.Pickles.Extensions;
 using PicklesDoc.Pickles.ObjectModel;
 
@@ -57,12 +58,7 @@ public INode Create(FileSystemInfoBase root, FileSystemInfoBase location)
             if (this.relevantFileDetector.IsFeatureFile(file))
             {
                 Feature feature = this.featureParser.Parse(file.FullName);
-                if (feature != null)
-                {
-                    return new FeatureNode(file, relativePathFromRoot, feature);
-                }
-
-                throw new InvalidOperationException("This feature file could not be read and will be excluded");
+                return feature != null ? new FeatureNode(file, relativePathFromRoot, feature) : null;
             }
             else if (this.relevantFileDetector.IsMarkdownFile(file))
             {

src/Pickles/Pickles/FeatureParser.cs

@@ -20,7 +20,7 @@
 
 using System;
 using System.IO.Abstractions;
-
+using System.Linq;
 using PicklesDoc.Pickles.ObjectModel;
 
 using TextReader = System.IO.TextReader;
@@ -74,8 +74,10 @@ public Feature Parse(TextReader featureFileReader)
                 new Gherkin.TokenMatcher(new CultureAwareDialectProvider(language)));
 
             Feature result = new Mapper(this.configuration, gherkinDocument.Feature.Language).MapToFeature(gherkinDocument);
+            result = this.RemoveFeatureWithIgnoreTag(result);
 
-            this.descriptionProcessor.Process(result);
+            if (result != null)
+                this.descriptionProcessor.Process(result);
 
             return result;
         }
@@ -90,5 +92,18 @@ private string DetermineLanguage()
             }
             return language;
         }
+
+        private Feature RemoveFeatureWithIgnoreTag(Feature result)
+        {
+            if (result.Tags.Any(t => t == $"@{configuration.IgnoreTag}"))
+                return null;
+
+            var wantedFeatures = result.FeatureElements.Where(fe => fe.Tags.All(t => t != $"@{configuration.IgnoreTag}")).ToList();
+
+            result.FeatureElements.Clear();
+            result.FeatureElements.AddRange(wantedFeatures);
+
+            return result;
+        }
     }
 }