crowbar-validate-databags 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03c3f56b163ad37d65048aa7e734c142e59258a3e341f9ea7337022bbe5bebd1
+  data.tar.gz: 94cb0dbd2f1a634f5fb7db253143ce0774a08d2171b3da5fa45acad47f2b8c4a
+SHA512:
+  metadata.gz: 0faff363042d37c5f17946b10967d303384de7eda4c8c953e4bd95f5120531ebbd66fc441bf6304c6a02dd1844ae002ef7d4d415aca4d15cb83b14e19b723ff4
+  data.tar.gz: d555259b2b97b4dbb77c9153c2e3e4a0d2d1b7ba9e226753987f10de5046440fdffd7ea28d8d382de9f735cc7f069437ecafd76b285ce2b85bb7dd490672a13f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.9
+before_install: gem install bundler -v 1.16.1
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "FGp9C8nO47WgQqI/yml1jDUQ6+B3rVeNtwSBnapXG/8ivb8rUHFKkkwnh4ayxMmIyUpqtJiqq6la94mtNYve1hI1sbp3siWvHac7RUJ8vQbdioFktSuxKZ41y0p4o00Mu1SE+8rjJVIzKn+lryLO1LglINrjVHC/ky7DNe9iSwtjjh1PYlgVzMoh+9HMUjJfd+x78zkrA0SLS3A+n1BJsL4QfnGgBlF3dbXa/GAmiFL4k1VYqfzVo9ApBpVJHbrGYEBn5B4bU6GRoFvN9Yy4ZtiKmY9sVkWMxrwe3mn/MQjCkBCTVi+Idp3mMj2yQqjMbs/iBIDGwyzaexzJWakmKhoQ/NEFzutq4w9oujbtA+Ts07SPdcW0jPR6wYdfeOxxzQwojg5HMXrB03LzTwE+k1oYLZJxQ8qJxB88jY7QhOKr+Cylxn0r9/rlTOZgDtDPGd/tTRPKQci5SK44RCBCB7whvMhUz+ZGyBZzzKFesskULmUIMo0sARY/+EBf61AYrKxT6ESMjsa3LwuYbsSPbVOqb1uhnVtBnrlDiTJmPAnjwXlkKbp6GxJ4nWHSJt25mSVuXvBZ9FmrXRYMT3bSvyI608lbf95Eyn9s15493U0+PVfQv3l8Zomb046jjprPDjz0F2PfQQsaPsk1fquvjTT/KSI0LuVz3GDb54Z/VN4="
+  on:
+    tags: true

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [1.0.0](https://github.com/crowbar/crowbar-validate-databags/releases/tag/v1.0.0) - 23-10-2018
+
+* Initial release (@itxaka)
+  * Checks for schema validation
+  * Checks for json validation
+  * Checks for migration duplication

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in crowbar-validate-databags.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Crowbar::Validate::Databags
+
+A gem to validate crowbar databags
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crowbar-validate-databags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crowbar-validate-databags
+
+## Usage
+
+    $ crowbar-validate-databags PATH/TO/DATABAGS/
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, first of all create a new local branch like `git checkout -b feature/version`
+for updating the `CHANGELOG.md` (please handle it the same way as in previous
+versions) and for raising the version number, you can find the version in
+`lib/crowbar/validate/databags/version.rb`.
+ 
+After merging the pull request it's time to build the rubygem and to release it.
+This is done automatically by Travis once a tag is pushed.
+
+Last, go to https://github.com/crowbar/crowbar-validate-databags/releases/new and select
+the pushed tag. Then you should put the latest changelog into the description
+form field.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/crowbar-validate-databags

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'crowbar/validate/databags'
+
+if true
+    if ARGV.size != 1
+        puts "Must specify the dir where the files are to validate (i.e. /opt/dell/crowbar/data_bags/crowbar/)\n"
+        exit -4
+    end
+    if !File.exists?(ARGV[0])
+        puts "#{ARGV[0]} must exist\n"
+        exit -5
+     end
+
+    rc = Crowbar::Validate::Databags.validate(ARGV[0])
+    if rc.include?(-1)
+        puts "Schema validation failed.\n"
+    elif rc.include?(-2)
+        puts "Json validation failed.\n"
+    elif rc.include?(-3)
+        puts "Migration files validation failed.\n"
+    end
+    exit rc.min
+end

data/crowbar-validate-databags.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "crowbar/validate/databags/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "crowbar-validate-databags"
+  spec.version       = Crowbar::Validate::Databags::VERSION
+  spec.authors       = ["Itxaka Serrano Garcia", "Rick Salevsky"]
+  spec.email         = ["igarcia@suse.com", "rsalevsky@suse.com"]
+
+  spec.summary       = %q{Validates databags of crowbar.}
+  spec.homepage      = "http://github.com/itxaka/crowbar-validate-databags"
+  spec.license       = "GPL-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["crowbar-validate-databags"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "kwalify", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/crowbar/validate/crowbarvalidator.rb

@@ -0,0 +1,100 @@
+require 'kwalify'
+require 'uri'
+
+
+class CrowbarValidator < Kwalify::Validator
+  def initialize(schema_filename)
+    super(Kwalify::Yaml.load_file(schema_filename))
+  end
+
+  ## hook method called by Validator#validate()
+  def validate_hook(value, rule, path, errors)
+    case rule.name
+    when "DiskURL"
+      begin
+        arr = URI.split(value)
+        if arr[0] != "disk"
+          msg = "Should have protocol disk: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+        if arr[2] == ""
+          msg = "Should have host specified: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+        if arr[5] == ""
+          msg = "Should have path specified: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+      rescue URI::InvalidURIError
+        msg = "Should be a valid URI: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+    when "FQDN"
+      subregex = /[a-zA-Z0-9\-]{1,63}/
+      endregex = /[\-]\z/
+      startregex = /\A[\-]/
+      numberregex = /\A\d+\z/
+
+      if value.length > 254
+        msg = "Should be a shorter than 254 characters: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+
+      arr = value.split(".")
+      if arr.length < 2
+        msg = "Must contain 2 or more subdomains: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+      if arr.last.length < 2
+        msg = "Last subdomain must be more than 1 character: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+      arr.each do |dn|
+        if dn[subregex].nil?
+          msg = "Can only contain _-A-Za-z0-9: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+        if !dn[endregex].nil?
+          msg = "Last character can not be - or _: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+        if !dn[startregex].nil?
+          msg = "First character can not be - or _: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+        if !dn[numberregex].nil?
+          msg = "Subdomain can not be only numbers: #{value}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+      end
+    when "Email"
+      regex = /\A([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)\z/
+      if value[regex].nil?
+        msg = "Should be an Email Address: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+    when "DomainName"
+      # http://tools.ietf.org/html/rfc1034#section-3.5
+      label = /[a-z]([a-z0-9\-]{0,61}[a-z0-9])?/i
+      regex = /\A#{label}(\.#{label})*\z/
+      if value[regex].nil?
+        msg = "Should be a Domain Name: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+    when "IpAddress"
+      regex = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
+      if value[regex].nil?
+        msg = "Should be an IP Address: #{value}"
+        errors << Kwalify::ValidationError.new(msg, path)
+      end
+    when "IpAddressMap"
+      regex = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
+      value.each_key do |key|
+        if key[regex].nil?
+          msg = "Should be an IP Address: #{key}"
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/validate/databags.rb

@@ -0,0 +1,65 @@
+require 'crowbar/validate/databags/version'
+require 'crowbar/validate/crowbarvalidator'
+require 'kwalify'
+
+module Crowbar
+  module Validate
+    module Databags
+      def self.validate(dir)
+        # add missing slash if needed
+        dir = "#{dir}/" unless dir[-1] == "/"
+
+        schema_files = Dir["#{dir}*.schema"].reject { |f| File.directory? f }
+        migration_folders = Dir["#{dir}migrate/*/"]
+
+        rc = []
+        schema_files.each { |schema| rc.push(validate_schema(schema)) }
+        schema_files.each { |schema| rc.push(validate_json(schema)) }
+        migration_folders.each { |folder| rc.push(validate_migrations(folder)) }
+        return rc.uniq
+
+      end
+
+      def self.validate_schema(schema_filename)
+        metavalidator = Kwalify::MetaValidator.instance
+        parser = Kwalify::Yaml::Parser.new(metavalidator)
+        parser.parse_file(schema_filename)
+
+        if parser.errors && !parser.errors.empty?
+          parser.errors.each do |e|
+            puts "#{schema_filename}: #{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
+          end
+          return -1
+        end
+        return 0
+      end
+
+      def self.validate_json(schema_filename)
+        config_filename = schema_filename.sub(".schema", ".json")
+        validator = CrowbarValidator.new(schema_filename)
+        parser = Kwalify::Yaml::Parser.new(validator)
+        parser.parse_file(config_filename)
+
+        if parser.errors && !parser.errors.empty?
+          parser.errors.each do |e|
+            puts "#{config_filename}: #{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
+          end
+          return -2
+        end
+        return 0
+      end
+
+      def self.validate_migrations(folder)
+        folder = "#{folder}/" unless folder[-1] == "/"
+        files = Dir["#{folder}*.rb"]
+        migration_numbers = files.map { |f| File.basename(f)[0, 3] }
+        duplicated = migration_numbers.select { |m| migration_numbers.count(m) > 1 }.uniq
+        unless duplicated.empty?
+          puts "Found duplicated number migration(s) on #{folder} with number(s) #{duplicated}"
+          return -3
+        end
+        return 0
+      end
+    end
+  end
+end

data/lib/crowbar/validate/databags/version.rb

@@ -0,0 +1,7 @@
+module Crowbar
+  module Validate
+    module Databags
+      VERSION = "1.0.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: crowbar-validate-databags
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Itxaka Serrano Garcia
+- Rick Salevsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- igarcia@suse.com
+- rsalevsky@suse.com
+executables:
+- crowbar-validate-databags
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/crowbar-validate-databags
+- crowbar-validate-databags.gemspec
+- lib/crowbar/validate/crowbarvalidator.rb
+- lib/crowbar/validate/databags.rb
+- lib/crowbar/validate/databags/version.rb
+homepage: http://github.com/itxaka/crowbar-validate-databags
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Validates databags of crowbar.
+test_files: []