norad_cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f317f6169f280d37dcf3f342361e7c4254f5599
-  data.tar.gz: 942032c69b1630bebd3107617799abda9e1a713f
+  metadata.gz: 3d7d5fad53b4b887fda38b20367eaaf423b10da0
+  data.tar.gz: f15052a70f7c23692472cc0e028447833995a1f2
 SHA512:
-  metadata.gz: ba8692954a43ba7fb99e902e8f8d6351f696f3f448d988aecf58a857f4c3b8f4c6ee807670dd5dd9bf12dfcf4b20523baa690659c45ed5cad278519584fe65a4
-  data.tar.gz: dce51da0d3e7daffe7e306885fb19b4d5f565ff46884f309bc92ca1b48b0c18fe4d0430a99e430ee31414bedf56206f847d0bdad2b5d975049b446f553218f1b
+  metadata.gz: f6cd71926c664c17e150b3dd14119210d9511adb20295a32def87e31d45d94d07f0c376128817d67e17ff6ede01a023dfa2562aec9c972e2e9229443a7de4033
+  data.tar.gz: d4a7170d6be6020b59ce6ff241a3dbb2ed76778ad0c7223bfc268149329d4ec7cfd2502c7a4cadb1aedc8b03b08905d79563efa0cae113df20eb5c23ad13fa87

data/.rubocop.yml

@@ -18,10 +18,12 @@ Metrics/AbcSize:
   Exclude:
     - 'lib/norad_cli/support/api_security_container_seed_script.rb'
     - 'lib/norad_cli/cli/sectest.rb'
+    - 'lib/norad_cli/support/manifest_spec.rb'
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'lib/norad_cli/cli/sectest.rb'
+    - 'lib/norad_cli/support/manifest_spec.rb'
 Metrics/ClassLength:
   Exclude:
     - 'lib/norad_cli/cli/sectest.rb'
@@ -30,8 +32,15 @@ Style/NegatedIf:
     - 'lib/norad_cli/cli/sectest.rb'
 Security/YAMLLoad:
   Exclude:
-    - 'lib/norad_cli/support/manifest.rb' 
+    - 'lib/norad_cli/support/manifest.rb'
     - 'lib/norad_cli/support/api_security_container_seed_script.rb'
+    - 'lib/norad_cli/support/manifest_spec.rb'
 Performance/RegexpMatch:
   Exclude:
     - 'lib/norad_cli/cli/sectest.rb'
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/norad_cli/support/manifest_spec.rb'
+Style/Next:
+  Exclude:
+    - 'lib/norad_cli/support/manifest_spec.rb'

data/lib/norad_cli/cli/sectest.rb

@@ -191,6 +191,27 @@ class Sectest < Thor
     SeedGenerator.process_manifests(options[:seedfile], options[:docsite])
   end
 
+  desc 'validate:image SECTESTNAME', 'Validate SECTESTNAME manifest.yml and readme.md'
+  define_method 'validate:image' do |name|
+    # Validate the readme file
+    ENV['sectest_name'] = name
+    RSpec::Core::Runner.run(["#{File.dirname(File.expand_path(__FILE__))}/../support/readme_spec.rb"], $stderr, $stdout)
+
+    # Validate the manifest file
+    RSpec::Core::Runner.run(["#{File.dirname(File.expand_path(__FILE__))}/../support/manifest_spec.rb"], $stderr, $stdout)
+  end
+
+  desc 'validate', 'Validate all manifest.yml and readme.md'
+  def validate
+    # Error check to ensure this is a plugin directory
+    Dir.glob('sectests/*').select do |f|
+      if File.directory? f
+        # Build all for the sectest
+        send('validate:image', f.split('/')[-1])
+      end
+    end
+  end
+
   no_tasks do
     def dockerfile?(img_dir)
       # Ensure the Dockerfile exists for the new tool

data/lib/norad_cli/support/manifest_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+require 'safe_yaml'
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+class Manifest
+  attr_accessor :values
+
+  def initialize(manifest_file)
+    f = File.new manifest_file, 'r'
+    @values = YAML.load f.read
+  end
+
+  def name
+    "#{@values['registry']}/#{@values['name']}:#{@values['version']}"
+  end
+end
+
+describe Manifest do
+  def testing_for(s)
+    puts "Testing for #{s}..."
+  end
+
+  def ok
+    puts 'OK'
+  end
+
+  def symbolize(h)
+    h.each_with_object({}) do |p, obj|
+      obj[p.first.to_sym] = p.last
+    end
+  end
+
+  def manifest_name_check(manifest)
+    testing_for 'valid name'
+    expect(manifest.values['name']).to_not eq(nil)
+    expect(manifest.values['name'] =~ %r{\A[A-Za-z][A-Za-z0-9_-]+\z}).to_not eq(nil)
+  end
+
+  def manifest_version_check(manifest)
+    testing_for 'existence of version'
+    expect(manifest.values['version']).to_not eq(nil)
+    expect(manifest.values['version'].is_a?(String)).to eq(true)
+    expect(manifest.values['version']).to match(/\A[a-zA-Z0-9:._-]+\z/)
+  end
+
+  def manifest_registry_check(manifest)
+    testing_for 'existence of registry'
+    expect(manifest.values['registry']).to_not eq(nil)
+    expect(manifest.values['registry'].is_a?(String)).to eq(true)
+  end
+
+  def manifest_test_types_check(manifest)
+    testing_for 'test types'
+    expect(manifest.values['test_types']).to_not eq(nil)
+    expect(manifest.values['test_types'].empty?).to eq(false)
+  end
+
+  def manifest_configurable_check(manifest)
+    testing_for 'configurability'
+    if manifest.values['configurable']
+      expect(manifest.values['default_config']).to_not be(nil)
+    else
+      expect(manifest.values['default_config']).to be(nil)
+    end
+  end
+  CONFIG_SHIM = { ssh_user: '', ssh_key: '', target: '' }.freeze
+  it 'validates the manifest file of all containers' do
+    next if File.exist?("sectests/#{ENV['sectest_name']}/.parent_only")
+    puts "Looking for valid manifest in: #{p}..."
+    manifest = Manifest.new "sectests/#{ENV['sectest_name']}/manifest.yml"
+    ok
+    manifest_name_check(manifest)
+    ok
+    manifest_version_check manifest
+    ok
+    manifest_registry_check manifest
+    ok
+    testing_for 'valid prog args'
+    expect(manifest.values['prog_args']).to_not eq(nil)
+    expect(manifest.values['prog_args'].scan('%{target}').length).to eq(1)
+    category = manifest.values['category']
+    assert false unless category == 'blackbox' || category == 'whitebox'
+    if category == 'blackbox'
+      expect(manifest.values['prog_args'].scan('%{ssh_user}').length).to eq(0)
+      expect(manifest.values['prog_args'].scan('%{ssh_key}').length).to eq(0)
+    else
+      expect(manifest.values['prog_args'].scan('%{ssh_user}').length).to eq(1)
+      expect(manifest.values['prog_args'].scan('%{ssh_key}').length).to eq(1)
+    end
+    ok
+    manifest_test_types_check manifest
+    ok
+    manifest_configurable_check manifest
+    ok
+    testing_for 'variants'
+    puts 'No variants for this repo' unless Dir.exist?("sectests/#{ENV['sectest_name']}/variants")
+    ok
+    Dir.glob("sectests/#{ENV['sectest_name']}/variants/*").each do |variant|
+      v_manifest = Manifest.new "#{variant}/manifest.yml"
+      manifest_name_check v_manifest
+      ok
+      manifest_registry_check v_manifest
+      ok
+      manifest_version_check v_manifest
+      ok
+      manifest_test_types_check v_manifest
+      ok
+      manifest_configurable_check v_manifest
+      ok
+      if v_manifest.values['default_config'] && manifest.values['default_config']
+        testing_for 'default config keys match base config keys'
+        expect(v_manifest.values['default_config'].keys).to match_array(manifest.values['default_config'].keys)
+        ok
+      end
+    end
+    puts
+  end
+end

data/lib/norad_cli/support/readme_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+class Readme
+end
+
+describe Readme do
+  def testing_for(s)
+    puts "Testing for #{s}..."
+  end
+
+  def ok
+    puts 'OK'
+  end
+
+  it 'requires each tool to have a README' do
+    next if File.exist?("sectests/#{ENV['sectest_name']}/.parent_only")
+    puts "Looking for README.md in: sectests/#{ENV['sectest_name']}..."
+    readme = File.read "sectests/#{ENV['sectest_name']}/README.md"
+    ok
+
+    testing_for 'variant READMEs'
+    puts 'No variants for this tool' unless Dir.exist?("sectests/#{ENV['sectest_name']}/variants")
+    ok
+    Dir.glob("sectests/#{ENV['sectest_name']}/variants/*").each do |variant|
+      readme = File.read "#{variant}/README.md"
+      ok
+    end
+  end
+end

data/lib/norad_cli/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module NoradCli
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: norad_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Blake Hitchcock
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -194,8 +194,8 @@ files:
 - lib/norad_cli/cli/secrepo.rb
 - lib/norad_cli/cli/sectest.rb
 - lib/norad_cli/support/api_security_container_seed_script.rb
-- lib/norad_cli/support/manifest.rb
-- lib/norad_cli/support/readme.rb
+- lib/norad_cli/support/manifest_spec.rb
+- lib/norad_cli/support/readme_spec.rb
 - lib/norad_cli/templates/.gitignore
 - lib/norad_cli/templates/.rspec
 - lib/norad_cli/templates/CONTRIBUTING.md

data/lib/norad_cli/support/manifest.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-require 'safe_yaml'
-SafeYAML::OPTIONS[:default_mode] = :safe
-
-class Manifest
-  attr_accessor :values
-
-  def initialize(manifest_file)
-    f = File.new manifest_file, 'r'
-    @values = YAML.load f.read
-  end
-
-  def name
-    "#{@values['registry']}/#{@values['name']}:#{@values['version']}"
-  end
-end

data/lib/norad_cli/support/readme.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-class Readme
-end