norad_cli 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d84fbf79a2180fae8bee968dd26f8259c789ae2
-  data.tar.gz: b5ab5d02cd70e0f491157fd50e63a4af11ac84a0
+  metadata.gz: 0ad7646308ba9f6cd0a67827779ec7fd05c6d992
+  data.tar.gz: 9a774b2c7fe5e97f1b1090099330af3e9a35f917
 SHA512:
-  metadata.gz: a2bb0686835ae130de5203e1a93559c1faf14de75da90a3f20e35de2f381061f1edc205618966598c8011c670afea33f75f3fdbd11912c1115e190e84c18d8ee
-  data.tar.gz: 378538d34d81e0c664c0b663106be66cf55fc1328e5d2e56fecffe4ec9fa86e305fc326078a717e5d535cb66a6687cb961ef2a7c5518d162a1184ca65971a222
+  metadata.gz: b748b7146ec63d642e7299c2224119be7d6cd9878e4498eeaebe10a1ec9fa5181e4dd6943cd9c740dc896225fcfb93194e6d2a2702d8386a024bb80f97ff8d14
+  data.tar.gz: 5528ce3dcb526c735ce929bd05db1dc0a57c6a2927bbe66e8cc24509bf26ed0fd061eb1b8b85c16040f9086ece12673aa8138add39a952694b2e55a58759b436

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    norad_cli (0.2.3)
+    norad_cli (0.2.4)
       docker-api
       git
       rainbow (~> 2.2.1)

data/lib/norad_cli/cli/sectest.rb

@@ -5,6 +5,7 @@ require 'git'
 require 'docker'
 require 'norad_cli/support/api_security_container_seed_script'
 require 'norad_cli/support/sectest_container'
+require 'norad_cli/support/ui_seed_generator'
 require 'rspec'
 require 'json'
 require 'rainbow'
@@ -280,6 +281,13 @@ class Sectest < Thor
     SeedGenerator.process_manifests(options[:seedfile], options[:docsite])
   end
 
+  desc 'seed:private_repo', 'Generate seed to import into UI. '\
+                            'Example: `norad sectest seed:private_repo <manifest_path1> <manifest_path2>` '\
+                            '(for all tests run without args)'
+  define_method 'seed:private_repo' do |*manifest_paths|
+    NoradCli::UiSeedGenerator.new(manifest_paths).process!
+  end
+
   desc 'validate:image SECTESTNAME', 'Validate SECTESTNAME manifest.yml and readme.md'
   define_method 'validate:image' do |name|
     run_validations(name)

data/lib/norad_cli/support/ui_seed_generator.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module NoradCli
+  class UiSeedGenerator
+    REQUIRED_ATTRIBUTES = %w[name prog_args test_types].freeze
+    OPTIONAL_ATTRIBUTES = %w[category multi_host configurable help_url default_config service].freeze
+    ALLOWED_ATTRIBUTES = REQUIRED_ATTRIBUTES | OPTIONAL_ATTRIBUTES
+
+    def initialize(manifest_paths)
+      @manifest_paths = if manifest_paths.empty?
+                          Dir.glob('./**/manifest.yml')
+                        else
+                          manifest_paths
+                        end
+    end
+
+    def process!
+      configurations = []
+      @manifest_paths.each { |manifest_path| configurations << configuration_from_manifest(manifest_path) }
+      save_seed_file!(configurations)
+    rescue ManifestError => e
+      puts e.message
+    end
+
+    private
+
+    def seed_path
+      "#{Dir.pwd}/seed.yml"
+    end
+
+    def save_seed_file!(configurations)
+      File.open(seed_path, 'w') { |f| f.write YAML.dump(configurations) }
+    end
+
+    def configuration_from_manifest(manifest_path)
+      raise ManifestNotFoundError, manifest_path unless File.exist?(manifest_path)
+
+      seed = YAML.safe_load(File.read(manifest_path))
+      validate_seed(manifest_path, seed)
+      seed['name'] = seed['version'] ? "#{seed['name']}:#{seed['version']}" : seed['name']
+
+      sanitize_seed(seed)
+    end
+
+    def sanitize_seed(seed)
+      seed.each_key { |key| seed.delete(key) unless ALLOWED_ATTRIBUTES.include?(key) }
+    end
+
+    def validate_seed(manifest_path, seed)
+      raise InvalidManifestError, manifest_path unless seed.is_a?(Hash)
+      return if REQUIRED_ATTRIBUTES & seed.keys == REQUIRED_ATTRIBUTES
+      raise ManifestMissingAttributesError.new(manifest_path, REQUIRED_ATTRIBUTES - seed.keys)
+    end
+
+    class ManifestError < StandardError
+      attr_reader :manifest_path
+
+      def initialize(manifest_path)
+        @manifest_path = manifest_path
+      end
+    end
+
+    class ManifestNotFoundError < ManifestError
+      def message
+        "Could not find manifest provided: #{manifest_path}"
+      end
+    end
+
+    class ManifestMissingAttributesError < ManifestError
+      attr_reader :attributes
+
+      def initialize(manifest_path, attributes)
+        @manifest_path = manifest_path
+        @attributes = attributes
+      end
+
+      def message
+        "Invalid manifest: #{manifest_path}. Missing attributes: #{attributes.join(', ')}"
+      end
+    end
+
+    class InvalidManifestError < ManifestError
+      def message
+        "Invalid manifest: #{manifest_path}. See Norad security test repositories page for guidelines."
+      end
+    end
+  end
+end

data/lib/norad_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NoradCli
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: norad_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Blake Hitchcock
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -200,6 +200,7 @@ files:
 - lib/norad_cli/support/readme_spec.rb
 - lib/norad_cli/support/results_server.rb
 - lib/norad_cli/support/sectest_container.rb
+- lib/norad_cli/support/ui_seed_generator.rb
 - lib/norad_cli/templates/.gitignore
 - lib/norad_cli/templates/.rspec
 - lib/norad_cli/templates/CONTRIBUTING.md