a2 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a07949036888c04e62fc52f79128f2dcadc32c3774c13677ea127f4492ba71
-  data.tar.gz: e74e45e471da6be643120a0c38a83ece3dc02f5b9e28d6fdd08651e98d058ead
+  metadata.gz: 5ab4e4782cc17d7bdd25d29feda56c81d4dbff2e911f19e9d723f5ecf66801f7
+  data.tar.gz: 4993432169fd2305698ee7f1106b0b2a83576eef287ac7065d2543ed38b1cae4
 SHA512:
-  metadata.gz: 9f3b5a94eea60a22bf4617725e828569cfa5223482f441982159585438080a63f0d5f4b50ebe500b50c42fcd2c5c4b723afeaa170a69e9e81a069c3b297a1d97
-  data.tar.gz: 75b703e75a824ccfaa4736679b999653ad3397ccd0c84d050830a5ff6acf4c5d9b8874283b74808c095c6416441dd2d9b23c9a64dc6a9a28d0e4608106ab794c
+  metadata.gz: 5cdab720df6fc757d7392598e2ddefed1dfe0883013aca3eb63c95b9b8644ea02de60967b751758c73b312da36d2280ee758a1ae6cbbd92ba9a109ae9d1086ed
+  data.tar.gz: e61c4e157f94ff5aca7f69808967cafa12c487bb0978af6726b6772e71d69774791e04c4b04c512ab31857faa15fcca510e645cfc8f3b1d81f6a33b2f2894e3b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    a2 (0.1.1)
+    a2 (0.2.0)
       cmdparse
       httparty
 

data/README.md

@@ -27,15 +27,11 @@ SSL_NO_VERIFY=true
 List the available commands:
 
     $ a2 --help
-    Usage: a2 [options] {cfgmgmt | help | iam | node | version}
+    Usage: a2 [options] {compliance | help | iam | infra | nodemgmt | version}
 
     Available commands:
-        cfgmgmt           Chef Infra config management commands
-          list-missing-nodes
-          list-node-status-counts
-          list-nodes
-          list-orgs
-          show-attributes
+        compliance        Compliance management commands
+          export-node-reports
         help              Provide help for individual commands
         iam               Identity access management commands
           add-membership
@@ -52,7 +48,15 @@ List the available commands:
           remove-membership
           update-team
           update-user
-        node              Node commands
+        infra             Chef Infra config management commands
+          list-missing-nodes
+          list-node-runs
+          list-node-status-counts
+          list-nodes
+          list-orgs
+          show-attributes
+          show-node-run
+        nodemgmt          Node management commands
           bulk-delete-by-filter
           bulk-delete-by-ids
           delete

data/lib/a2/client.rb

@@ -1,5 +1,6 @@
 require_relative 'client/config_mgmt'
 require_relative 'client/nodes'
+require_relative 'client/reporting'
 require_relative 'client/teams'
 require_relative 'client/users'
 
@@ -7,6 +8,7 @@ module A2
   class Client
     include A2::Client::ConfigMgmt
     include A2::Client::Nodes
+    include A2::Client::Reporting
     include A2::Client::Teams
     include A2::Client::Users
 
@@ -45,6 +47,18 @@ module A2
       JSON.parse(response.body)
     end
 
+    def download_report(path, json, output_file)
+      File.open(output_file, "w") do |file|
+        HTTParty.post(File.join(@automate_url, path).to_s, {
+          verify: !@ssl_no_verify,
+          headers: {"api-token" => @automate_token},
+          body: json
+        }) do |fragment|
+          file.write(fragment)
+        end
+      end
+    end
+
     def delete(path)
       response = HTTParty.delete(File.join(@automate_url, path).to_s, {
         verify: !@ssl_no_verify,

data/lib/a2/client/config_mgmt.rb

@@ -9,6 +9,10 @@ module A2
         get "/api/v0/cfgmgmt/stats/missing_node_duration_counts#{query_string}"
       end
 
+      def list_all_node_runs(node_id, query_string = '')
+        get "/api/v0/cfgmgmt/nodes/#{node_id}/runs#{query_string}"
+      end
+
       def list_all_node_status_counts(query_string = '')
         get "/api/v0/cfgmgmt/stats/node_counts#{query_string}"
       end
@@ -20,6 +24,10 @@ module A2
       def show_attributes(node_id)
         get "/api/v0/cfgmgmt/nodes/#{node_id}/attribute"
       end
+
+      def show_node_run(node_id, run_id, query_string = '')
+        get "/api/v0/cfgmgmt/nodes/#{node_id}/runs/#{run_id}#{query_string}"
+      end
     end
   end
 end

data/lib/a2/client/reporting.rb

@@ -0,0 +1,9 @@
+module A2
+  class Client
+    module Reporting
+      def export_node_reports(json, output_file)
+        download_report '/api/v0/compliance/reporting/node/export', json, output_file
+      end
+    end
+  end
+end

data/lib/a2/command.rb

@@ -1,3 +1,4 @@
+require_relative 'commands/compliance'
 require_relative 'commands/iam'
 require_relative 'commands/infra'
 require_relative 'commands/node_mgmt'

data/lib/a2/commands/compliance.rb

@@ -0,0 +1,14 @@
+require_relative '../subcommands/reporting'
+
+module A2
+  module Command
+    class Compliance < CmdParse::Command
+      def initialize
+        super('compliance')
+        short_desc('Compliance management commands')
+        long_desc('Compliance management commands')
+        add_command(A2::Subcommand::Reporting::ExportNodeReports.new)
+      end
+    end
+  end
+end

data/lib/a2/commands/infra.rb

@@ -9,9 +9,11 @@ module A2
         long_desc('Chef Infra config management commands')
         add_command(A2::Subcommand::Infra::ListAllCheckedInNodes.new)
         add_command(A2::Subcommand::Infra::ListMissingNodesCount.new)
+        add_command(A2::Subcommand::Infra::ListNodeRuns.new)
         add_command(A2::Subcommand::Infra::ListNodeStatusCounts.new)
         add_command(A2::Subcommand::Infra::ListOrganizations.new)
         add_command(A2::Subcommand::Infra::ShowAttributes.new)
+        add_command(A2::Subcommand::Infra::ShowNodeRun.new)
       end
     end
   end

data/lib/a2/mixins/filtered.rb

@@ -1,44 +1,44 @@
 module A2
-  module Filtered
+  class Filtered < CmdParse::Command
     def initialize(name, opts = {})
       set_custom_opts!(opts)
       super(name, opts)
-      set_filter_optparse_options!(options)
+      set_filter_optparse_options!(options, @query_filter)
     end
 
     def set_custom_opts!(opts)
       @opt ||= {}
-      @opt[:query_filter] = opts.delete(:query_filter) || false
+      @query_filter = opts.delete(:query_filter) || false
+      @filter_key = opts.delete(:filter_key) || 'key'
     end
 
-    def set_filter_optparse_options!(options)
+    def set_filter_optparse_options!(options, query_filter)
       options.on('-f', '--filters FILTERS', 'A comma-separated list of filters.') do |filters|
         @opt[:filters] = filters
       end
-      # Only available for POST body filters
-      options.on('-j', '--json-file FILE', 'Path to a json file containing a filter payload.') do |file|
-        @opt[:json_file] = file
-      end unless query_filter?
-      # Only available for query parameter filters
-      options.on('-S', '--start START', 'Earliest most recent check-in node information to return. Formatted iso8601 (YYYY-MM-DD\'T\'HH:mm:ssZ)') do |start|
-        @opt[:start] = start
-      end if query_filter?
-      options.on('-E', '--end END', 'Latest most recent check-in node information to return. Formatted iso8601 (YYYY-MM-DD\'T\'HH:mm:ssZ)') do |end_arg|
-        @opt[:end] = end_arg
-      end if query_filter?
-    end
-
-    def query_filter?
-      @opt[:query_filter]
+      if query_filter
+        # Only available for query parameter filters
+        options.on('-S', '--start-time START', 'Earliest most recent check-in node information to return. Formatted iso8601 (YYYY-MM-DD\'T\'HH:mm:ssZ)') do |start_time|
+          @opt[:start] = start_time
+        end
+        options.on('-E', '--end-time END', 'Latest most recent check-in node information to return. Formatted iso8601 (YYYY-MM-DD\'T\'HH:mm:ssZ)') do |end_time|
+          @opt[:end] = end_time
+        end
+      else
+        # Only available for POST body filters
+        options.on('-j', '--json-file FILE', 'Path to a json file containing a filter payload.') do |file|
+          @opt[:json_file] = file
+        end
+      end
     end
 
     def parse_filters(filters)
       parsed_filters = []
       filters.split(',').each do |f|
-        k,v = f.split(':')
+        k,*v = f.split(':')
         parsed_filters << {
-          'key' => k,
-          'values' => [v]
+          @filter_key => k,
+          'values' => [v.join(':')]
         }
       end
       parsed_filters

data/lib/a2/mixins/paginated.rb

@@ -1,33 +1,26 @@
 module A2
-  module Paginated
-    include A2::Filtered
+  class Paginated < Filtered
     def initialize(name, opts = {})
-      set_custom_opts!(opts)
+      disable_sort_opts = opts.delete(:disable_sort_opts) || false
       super(name, opts)
-      @opt = {
-        order: 'ASC'
-      }
+      @opt[:order] = 'ASC' unless disable_sort_opts
       options.on('-o', '--order ORDER', 'Return the results in ascending or descending order. Default is "ASC".') do |order|
         @opt[:order] = order
-      end
+      end unless disable_sort_opts
+      options.on('-s', '--sort SORT', 'Sort the results on a specific field.') do |sort|
+        @opt[:sort] = sort
+      end  unless disable_sort_opts
       options.on('-p', '--page PAGE', Integer, 'Starting page for the results. Default is 0') do |page|
         @opt[:page] = page
       end
       options.on('-P', '--per-page PER_PAGE', Integer, 'The number of results on each page. Default is 100') do |per_page|
         @opt[:per_page] = per_page
       end
-      options.on('-s', '--sort SORT', 'Sort the results on a specific field.') do |sort|
-        @opt[:sort] = sort
-      end
-      set_filter_optparse_options!(options)
-    end
-
-    def generate_paginated_json_filters
-      generate_json_filters
+      set_filter_optparse_options!(options, @query_filter)
     end
 
     def with_paginated_filter_json(&block)
-      json = generate_paginated_json_filters
+      json = generate_json_filters
       yield(json)
     end
 

data/lib/a2/parser.rb

@@ -5,6 +5,7 @@ module A2
       parser.main_options.version = A2::VERSION
       parser.add_command(CmdParse::HelpCommand.new)
       parser.add_command(CmdParse::VersionCommand.new)
+      parser.add_command(A2::Command::Compliance.new)
       parser.add_command(A2::Command::IAM.new)
       parser.add_command(A2::Command::Infra.new)
       parser.add_command(A2::Command::NodeMgmt.new)

data/lib/a2/subcommands/infra.rb

@@ -1,14 +1,13 @@
 module A2
   module Subcommand
     module Infra
-      class ListAllCheckedInNodes < CmdParse::Command
-        include A2::Paginated
+      class ListAllCheckedInNodes < Paginated
         def initialize
           super('list-nodes', takes_commands: false, query_filter: true)
         end
 
         def execute
-          with_filter_query do |query_string|
+          with_paginated_filter_query do |query_string|
             puts JSON.pretty_generate(A2::Client.new(command_parser.data).list_all_checked_in_nodes(query_string))
           end
         end
@@ -26,8 +25,18 @@ module A2
           puts JSON.pretty_generate(A2::Client.new(command_parser.data).list_all_missing_nodes_count(@opt[:durations]))
         end
       end
-      class ListNodeStatusCounts < CmdParse::Command
-        include A2::Filtered
+      class ListNodeRuns < Paginated
+        def initialize
+          super('list-node-runs', takes_commands: false, query_filter: true, disable_sort_opts: true)
+        end
+
+        def execute(node_id)
+          with_paginated_filter_query do |query_string|
+            puts JSON.pretty_generate(A2::Client.new(command_parser.data).list_all_node_runs(node_id, query_string))
+          end
+        end
+      end
+      class ListNodeStatusCounts < Filtered
         def initialize
           super('list-node-status-counts', takes_commands: false, query_filter: true)
         end
@@ -56,6 +65,22 @@ module A2
           puts JSON.pretty_generate(A2::Client.new(command_parser.data).show_attributes(node_id))
         end
       end
+      class ShowNodeRun < CmdParse::Command
+        def initialize
+          super('show-node-run', takes_commands: false)
+          @opt = {}
+          options.on('-E', '--end-time END', "End time on the node's run. Formatted iso8601 (YYYY-MM-DD\'T\'HH:mm:ssZ)") do |end_time|
+            @opt[:end_time] = end_time
+          end
+        end
+
+        def execute(node_id, run_id)
+          query_string = ''
+          query_string = "?end_time=#{@opt[:end_time]}" if @opt[:end_time]
+
+          puts JSON.pretty_generate(A2::Client.new(command_parser.data).show_node_run(node_id, run_id, query_string))
+        end
+      end
     end
   end
 end

data/lib/a2/subcommands/node_mgmt.rb

@@ -10,8 +10,7 @@ module A2
           puts JSON.pretty_generate(A2::Client.new(command_parser.data).get_managed_node(id))
         end
       end
-      class Search < CmdParse::Command
-        include A2::Paginated
+      class Search < Paginated
 
         def initialize
           super('search', takes_commands: false)
@@ -25,7 +24,6 @@ module A2
       end
       class Delete < CmdParse::Command
         include A2::Approved
-
         def initialize
           super('delete', takes_commands: false)
         end
@@ -38,7 +36,6 @@ module A2
       end
       class BulkDeleteById < CmdParse::Command
         include A2::Approved
-
         def initialize
           super('bulk-delete-by-ids', takes_commands: false)
         end
@@ -49,10 +46,8 @@ module A2
           end
         end
       end
-      class BulkDeleteByFilter < CmdParse::Command
+      class BulkDeleteByFilter < Paginated
         include A2::Approved
-        include A2::Paginated
-
         def initialize
           super('bulk-delete-by-filter', takes_commands: false)
         end

data/lib/a2/subcommands/reporting.rb

@@ -0,0 +1,30 @@
+module A2
+  module Subcommand
+    module Reporting
+      class ExportNodeReports < Paginated
+        def initialize
+          super('export-node-reports', takes_commands: false, filter_key: 'type')
+          @opt[:type] = 'csv'
+          options.on('-n', '--name NAME', 'Name of the profile (as defined in inspec.yml).') do |name|
+            @opt[:name] = name
+          end
+          options.on('-O', '--owner OWNER', 'Automate user associated with the profile.') do |owner|
+            @opt[:owner] = owner
+          end
+          options.on('-o', '--output OUTPUT_TYPE', 'Desired report data format (either "csv" or "json"). Default value is "csv".') do |output_type|
+            @opt[:type] = output_type
+          end
+        end
+
+        def execute(filename = nil, output_type = 'csv')
+          # Workaround for bug: https://github.com/chef/automate/issues/4926
+          @opt[:order] = @opt[:order].downcase.eql?('asc') ? 0 : 1
+          with_paginated_filter_json do |json|
+            filename ||= "report-#{Time.now.strftime('%Y%m%d%H%M%S')}.#{@opt[:type]}"
+            response = A2::Client.new(command_parser.data).export_node_reports(json, filename)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/a2/subcommands/team.rb

@@ -48,7 +48,6 @@ module A2
       end
       class Delete < CmdParse::Command
         include A2::Approved
-
         def initialize
           super('delete-team', takes_commands: false)
         end

data/lib/a2/version.rb

@@ -1,3 +1,3 @@
 module A2
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - gscho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,9 +106,11 @@ files:
 - lib/a2/client.rb
 - lib/a2/client/config_mgmt.rb
 - lib/a2/client/nodes.rb
+- lib/a2/client/reporting.rb
 - lib/a2/client/teams.rb
 - lib/a2/client/users.rb
 - lib/a2/command.rb
+- lib/a2/commands/compliance.rb
 - lib/a2/commands/iam.rb
 - lib/a2/commands/infra.rb
 - lib/a2/commands/node_mgmt.rb
@@ -118,6 +120,7 @@ files:
 - lib/a2/parser.rb
 - lib/a2/subcommands/infra.rb
 - lib/a2/subcommands/node_mgmt.rb
+- lib/a2/subcommands/reporting.rb
 - lib/a2/subcommands/team.rb
 - lib/a2/subcommands/user.rb
 - lib/a2/version.rb