Add output format option for legacy_json

Author: Kevin Paulisse

doc/optionsref.md

@@ -27,7 +27,7 @@ Usage: octocatalog-diff [command line options]
         --bootstrap-then-exit        Bootstrap from-dir and/or to-dir and then exit
         --[no-]color                 Enable/disable colors in output
     -o, --output-file FILENAME       Output results into FILENAME
-        --output-format FORMAT       Output format: text,json
+        --output-format FORMAT       Output format: text,json,legacy_json
     -d, --[no-]debug                 Print debugging messages to STDERR
     -q, --[no-]quiet                 Quiet (no status messages except errors)
         --ignore "Type1[Title1],Type2[Title2],..."
@@ -708,10 +708,12 @@ to ignore any changes for any defined type where this tag is set. (<a href="../l
       <pre><code>--output-format FORMAT</code></pre>
     </td>
     <td valign=top>
-      Output format: text,json
+      Output format: text,json,legacy_json
     </td>
     <td valign=top>
-      Output format option (<a href="../lib/octocatalog-diff/cli/options/output_format.rb">output_format.rb</a>)
+      Output format option. 'text' is human readable text, 'json' is an array of differences
+identified by human readable keys (the preferred octocatalog-diff 1.x format), and 'legacy_json' is an
+array of differences, where each difference is an array (the octocatalog-diff 0.x format). (<a href="../lib/octocatalog-diff/cli/options/output_format.rb">output_format.rb</a>)
     </td>
   </tr>
 

lib/octocatalog-diff/cli/options/output_format.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
-# Output format option
+# Output format option. 'text' is human readable text, 'json' is an array of differences
+# identified by human readable keys (the preferred octocatalog-diff 1.x format), and 'legacy_json' is an
+# array of differences, where each difference is an array (the octocatalog-diff 0.x format).
 # @param parser [OptionParser object] The OptionParser argument
 # @param options [Hash] Options hash being constructed; this is modified in this method.
 OctocatalogDiff::Cli::Options::Option.newoption(:output_format) do
   has_weight 100
 
   def parse(parser, options)
-    valid = %w(text json)
+    valid = %w(text json legacy_json)
     parser.on('--output-format FORMAT', "Output format: #{valid.join(',')}") do |fmt|
       raise ArgumentError, "Invalid format. Must be one of: #{valid.join(',')}" unless valid.include?(fmt)
       options[:format] = fmt.to_sym

spec/octocatalog-diff/integration/outputs_spec.rb

@@ -51,7 +51,7 @@
     expect(result[:output]).to match(pattern)
   end
 
-  it 'should write JSON output to a specified file' do
+  it 'should write 1.x JSON output to a specified file' do
     output_file = File.join(@tmpdir, 'octo-output.json')
     argv = default_argv.concat ['-o', output_file, '--output-format', 'json']
     result = OctocatalogDiff::Integration.integration(argv: argv)
@@ -63,6 +63,46 @@
     expect(data).to be_a_kind_of(Hash)
     expect(data['header']).to eq(nil)
     expect(data['diff']).to be_a_kind_of(Array)
+
+    answer = {
+      'diff_type' => '~',
+      'type' => 'File',
+      'title' => '/usr/bin/node-waf',
+      'structure' => %w(parameters ensure),
+      'old_value' => '/usr/share/nvm/0.8.11/bin/node-waf',
+      'new_value' => 'link',
+      'old_file' => '/environments/production/modules/nodejs/manifests/init.pp',
+      'old_line' => 55,
+      'new_file' => '/environments/production/modules/nodejs/manifests/init.pp',
+      'new_line' => 55,
+      'old_location' => { 'file' => '/environments/production/modules/nodejs/manifests/init.pp', 'line' => 55 },
+      'new_location' => { 'file' => '/environments/production/modules/nodejs/manifests/init.pp', 'line' => 55 }
+    }
+    expect(data['diff']).to include(answer)
+  end
+
+  it 'should write 0.x JSON output to a specified file' do
+    output_file = File.join(@tmpdir, 'octo-output.json')
+    argv = default_argv.concat ['-o', output_file, '--output-format', 'legacy_json']
+    result = OctocatalogDiff::Integration.integration(argv: argv)
+    expect(result[:exitcode]).to eq(2), OctocatalogDiff::Integration.format_exception(result)
+    expect(result[:logs]).to match(/Wrote diff to #{Regexp.escape(output_file)}/)
+    expect(File.file?(output_file)).to eq(true)
+    content = File.read(output_file)
+    data = JSON.parse(content)
+    expect(data).to be_a_kind_of(Hash)
+    expect(data['header']).to eq(nil)
+    expect(data['diff']).to be_a_kind_of(Array)
+
+    answer = [
+      '!',
+      "File\f/usr/bin/npm\fparameters\ftarget",
+      '/usr/share/nvm/0.8.11/bin/npm',
+      nil,
+      { 'file' => '/environments/production/modules/nodejs/manifests/init.pp', 'line' => 46 },
+      { 'file' => '/environments/production/modules/nodejs/manifests/init.pp', 'line' => 46 }
+    ]
+    expect(data['diff']).to include(answer)
   end
 
   it 'should write JSON output to the screen' do

spec/octocatalog-diff/tests/cli/options/output_format_spec.rb

@@ -4,7 +4,7 @@
 
 describe OctocatalogDiff::Cli::Options do
   describe '#opt_output_format' do
-    valid = %w(text json)
+    valid = %w(text json legacy_json)
     valid.each do |fmt|
       it "should set output format to #{fmt}" do
         result = run_optparse(['--output-format', fmt])