octocatalog-diff 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39148d81d6f446067f306d988b78a3544f381a47
-  data.tar.gz: e3212a9a0510be17e5bad0280baa66451cc3d77c
+  metadata.gz: a89d4a61710f5fd7a044241c3dd99d0d50ec2737
+  data.tar.gz: 362d9371778130cc5eda6978ce9563ac6a1d93e1
 SHA512:
-  metadata.gz: a2abdf4c5a2604c70938a50875dacc5af83e4ad4aeaa08ad2ac1e1c97a61c1cd4f47ad928cc361919993db5fb9fa5e70c76f29d172761e8c8bb8b3f68cf62e12
-  data.tar.gz: 2dbc74ab05804f35ae3106ccdbf494952f262110335e57c57f92f719387071289272fec6f6cea4db30b18b07d745b650a10708120ca9cda44e18a5e0ea3776fd
+  metadata.gz: 5fcf1c9e9373f21fc8c14cb3cca8163659e6b0be55a4c449e500d95f35172d29f546de3deba0028d2702e53310a77b9182a06dadace338ec15afa237ddb1fc90
+  data.tar.gz: cad1f341cf55e43336f1e1945035491f949f9d81d6cfa13359e5b9c8ae50b6caccf3e7c8c7822e86e05d09fdddff45c7135d2949b5cffe085ff9301cb10ae785

data/.version

@@ -1 +1 @@
-0.6.0
+0.6.1

data/doc/CHANGELOG.md

@@ -8,6 +8,15 @@
 </tr>
 </thead><tbody>
 <tr valign=top>
+<td>0.6.1</td>
+<td>2017-01-07</td>
+<td>
+<ul>
+<li><a href="https://github.com/github/octocatalog-diff/pull/46">#46</a>: Add option to ignore whitespace in yaml file diff</li>
+</ul>
+</td>
+</tr>
+<tr valign=top>
 <td>0.6.0</td>
 <td>2017-01-04</td>
 <td>

data/doc/advanced-filter.md

@@ -0,0 +1,26 @@
+# Additional output filters
+
+It is possible to enable additional filters for output results via the `--filters` command line option. This command line option accepts a comma-separated list of additional filters, and applies them to the results in the order you specify. The default behavior is not to use any of these filters.
+
+Please note that there are other options to ignore specified diffs, including:
+
+- [Ignoring certain changes via command line options](/doc/advanced-ignores.md)
+- [Dynamic ignoring of changes via tags in Puppet manifests](/doc/advanced-dynamic-ignores.md)
+
+Here is the list of available filters and an explanation of each:
+
+- [YAML](#YAML) - Ignore whitespace/comment differences if YAML parses to the same object
+
+## YAML
+
+#### Usage
+
+```
+--filters YAML
+```
+
+#### Description
+
+If a file resource has extension `.yml` or `.yaml` and a difference in its content is observed, YAML objects are constructed from the previous and new values. If these YAML objects are identical, the difference is ignored.
+
+This allows you to ignore changes in whitespace, comments, etc., that are not meaningful to a machine parsing the file. Please note that by filtering these changes, you are ignoring changes to comments, which may be meaningful to humans.

data/doc/advanced.md

@@ -27,6 +27,7 @@ See also:
 ### Controlling output
 
 - [Ignoring certain changes via command line options](/doc/advanced-ignores.md)
+- [Additional output filters](/doc/advanced-filter.md)
 - [Dynamic ignoring of changes via tags in Puppet manifests](/doc/advanced-dynamic-ignores.md)
 - [Output formats](/doc/advanced-output-formats.md)
 - [Useful output hacks](/doc/advanced-output-hacks.md)

data/doc/optionsref.md

@@ -46,6 +46,8 @@ Usage: octocatalog-diff [command line options]
         --no-hiera-path-strip        Do not use any default hiera path strip settings
         --ignore-attr "attr1,attr2,..."
                                      Attributes to ignore
+        --filters FILTER1[,FILTER2[,...]]
+                                     Filters to apply
         --[no-]display-source        Show source file and line for each difference
         --[no-]validate-references "before,require,subscribe,notify"
                                      References to validate
@@ -424,6 +426,20 @@ on which this is running. (<a href="../lib/octocatalog-diff/catalog-diff/cli/opt
     </td>
   </tr>
 
+  <tr>
+    <td valign=top>
+      <pre><code>--filters FILTER1[,FILTER2[,...]]</code></pre>
+    </td>
+    <td valign=top>
+      Filters to apply
+    </td>
+    <td valign=top>
+      Specify one or more filters to apply to the results of the catalog difference.
+For a list of available filters and further explanation, please refer to
+[Filtering results](/doc/advanced-filter.md). (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/filters.rb">filters.rb</a>)
+    </td>
+  </tr>
+
   <tr>
     <td valign=top>
       <pre><code>-f FROM_BRANCH

data/lib/octocatalog-diff/catalog-diff/cli/options/filters.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Specify one or more filters to apply to the results of the catalog difference.
+# For a list of available filters and further explanation, please refer to
+# [Filtering results](/doc/advanced-filter.md).
+# @param parser [OptionParser object] The OptionParser argument
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::CatalogDiff::Cli::Options::Option.newoption(:filters) do
+  has_weight 199
+
+  def parse(parser, options)
+    parser.on('--filters FILTER1[,FILTER2[,...]]', Array, 'Filters to apply') do |x|
+      options[:filters] ||= []
+      options[:filters].concat x
+    end
+  end
+end

data/lib/octocatalog-diff/catalog-diff/differ.rb

@@ -7,6 +7,7 @@ require 'set'
 require 'stringio'
 
 require_relative '../catalog'
+require_relative 'filter'
 
 module OctocatalogDiff
   module CatalogDiff
@@ -153,6 +154,9 @@ module OctocatalogDiff
         # out any such parameters from the result array.
         filter_diffs_for_absent_files(result) if @opts[:suppress_absent_file_details]
 
+        # Apply any additional pluggable filters.
+        OctocatalogDiff::CatalogDiff::Filter.apply_filters(result, @opts[:filters])
+
         # That's it!
         @logger.debug "Exiting catdiff; change count: #{result.size}"
         result
@@ -175,7 +179,7 @@ module OctocatalogDiff
         absent_files = Set.new
         result.each do |diff|
           next unless diff[0] == '~' || diff[0] == '!'
-          next unless diff[1] =~ /^File\f(.+)\fparameters\fensure$/
+          next unless diff[1] =~ /^File\f([^\f]+)\fparameters\fensure$/
           next unless ['absent', 'false', false].include?(diff[3])
           absent_files.add Regexp.last_match(1)
         end

data/lib/octocatalog-diff/catalog-diff/filter.rb

@@ -0,0 +1,38 @@
+require_relative 'filter/yaml'
+
+module OctocatalogDiff
+  module CatalogDiff
+    # Filtering of diffs, and parent class for inheritance.
+    class Filter
+      # Public: Apply multiple filters by repeatedly calling the `filter` method for each
+      # filter in an array. This method returns nothing.
+      #
+      # @param result [Array] Difference array (mutated)
+      # @param filter_names [Array] Filters to run
+      # @param options [Hash] Options for each filter (hashed by name)
+      def self.apply_filters(result, filter_names, options = {})
+        return unless filter_names.is_a?(Array)
+        filter_names.each { |x| filter(result, x, options[x] || {}) }
+      end
+
+      # Public: Perform a filter on `result` using the specified filter class.
+      # This mutates `result` by removing items that are ignored. This method
+      # returns nothing.
+      #
+      # @param result [Array] Difference array (mutated)
+      # @param filter_class_name [String] Filter class name (from `filter` subdirectory)
+      # @param options [Hash] Additional options (optional) to pass to filtered? method
+      def self.filter(result, filter_class_name, options = {})
+        filter_class_name = [name.to_s, filter_class_name].join('::')
+        clazz = Kernel.const_get(filter_class_name)
+        result.reject! { |item| clazz.filtered?(item, options) }
+      end
+
+      # Inherited: Construct a default `filtered?` method for the subclass via inheritance.
+      # Each subclass must implement this method, so the default method errors.
+      def self.filtered?(_item, _options = {})
+        raise "No `filtered?` method is implemented in #{name}"
+      end
+    end
+  end
+end

data/lib/octocatalog-diff/catalog-diff/filter/yaml.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module OctocatalogDiff
+  module CatalogDiff
+    class Filter
+      # Filter based on equivalence of YAML objects for file resources with named extensions.
+      class YAML < OctocatalogDiff::CatalogDiff::Filter
+        # Public: Actually do the comparison of YAML objects for appropriate resources.
+        # Return true if the YAML objects are known to be equivalent. Return false if they
+        # are not equivalent, or if equivalence cannot be determined.
+        #
+        # @param diff [Array] Difference
+        # @param _options [Hash] Additional options (there are none for this filter)
+        # @return [Boolean] true if this difference is a YAML file with identical objects, false otherwise
+        def self.filtered?(diff, _options = {})
+          # Skip additions or removals - focus only on changes
+          return false unless diff[0] == '~' || diff[0] == '!'
+
+          # Make sure we are comparing file content for a file ending in .yaml or .yml extension
+          return false unless diff[1] =~ /^File\f([^\f]+)\.ya?ml\fparameters\fcontent$/
+
+          # Attempt to convert the old (diff[2]) and new (diff[3]) into YAML objects. Assuming
+          # that doesn't error out, the return value is whether or not they're equal.
+          obj_old = ::YAML.load(diff[2])
+          obj_new = ::YAML.load(diff[3])
+          obj_old == obj_new
+        rescue # Rescue everything - if something failed, we aren't sure what's going on, so we'll return false.
+          false
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octocatalog-diff
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - GitHub, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -230,6 +230,7 @@ files:
 - doc/advanced-ci.md
 - doc/advanced-dynamic-ignores.md
 - doc/advanced-environments.md
+- doc/advanced-filter.md
 - doc/advanced-future-parser.md
 - doc/advanced-hiera-path-stripping.md
 - doc/advanced-ignores.md
@@ -291,6 +292,7 @@ files:
 - lib/octocatalog-diff/catalog-diff/cli/options/fact_file.rb
 - lib/octocatalog-diff/catalog-diff/cli/options/fact_override.rb
 - lib/octocatalog-diff/catalog-diff/cli/options/facts_terminus.rb
+- lib/octocatalog-diff/catalog-diff/cli/options/filters.rb
 - lib/octocatalog-diff/catalog-diff/cli/options/from_puppetdb.rb
 - lib/octocatalog-diff/catalog-diff/cli/options/header.rb
 - lib/octocatalog-diff/catalog-diff/cli/options/hiera_config.rb
@@ -339,6 +341,8 @@ files:
 - lib/octocatalog-diff/catalog-diff/display.rb
 - lib/octocatalog-diff/catalog-diff/display/json.rb
 - lib/octocatalog-diff/catalog-diff/display/text.rb
+- lib/octocatalog-diff/catalog-diff/filter.rb
+- lib/octocatalog-diff/catalog-diff/filter/yaml.rb
 - lib/octocatalog-diff/catalog-util/bootstrap.rb
 - lib/octocatalog-diff/catalog-util/builddir.rb
 - lib/octocatalog-diff/catalog-util/cached_master_directory.rb