kashi 0.1.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '055328ffe3f5ea256bb7b5a93ff93b955a87f502'
-  data.tar.gz: 772ae8d3b42689c100d474a375676790f3366377
+  metadata.gz: d7331c135793bad57b313139dcfc55669b67e7bf
+  data.tar.gz: f561bf7f18a29b38e489e042d453c68eddc9eeac
 SHA512:
-  metadata.gz: af45c16beb5e36f27cfde874292f3f1c659cbc3639376f4aad54b15609f1035c937c17a09a3ea4cd629a8df35c00100b8a23d7e930a64f0e4f182a37268d8acd
-  data.tar.gz: '0928ab0904b4f029cae919d0981216fbad95041e06b952923dd34ecddd20031e80d286ac6d42a936add1075b50cd4819513af5deb807bc6d6d1458d68ed97a94'
+  metadata.gz: ee5c53b2caf18c8d20fc33923d816bc7e9e6522472e036a0927db96c38a3ffddb729951f33c3921dcaaf60587cbf21316cbba8d594908cd97b79bfe51260efc2
+  data.tar.gz: a84b8e6ddb0fdae169065da94478e8db78ccd3a05892bb5cc4129f042b484ec463a4808c01b51903d38f5d651ad1982c5f367e1f1099ae373b82240a90e9add5

data/README.md

@@ -39,10 +39,14 @@ Usage: kashi [options]
     -n, --dry-run                    Dry run
         --no-color
                                      No color
+        --secret-provider NAME
+                                     use secret value expansion
     -s, --split                      Split export DLS file contact group and tests
         --split-more
                                      Split export DLS file to 1 per object
     -v, --debug                      Show debug log
+    -i, --include-names NAMES        include website_name
+    -x, --exclude-names NAMES        exclude website_name by regex
 ```
 
 ## SCfile
@@ -67,42 +71,56 @@ cake do
   end
 
   test do
+    paused 0
+
+    test_type "HTTP"
+
+    # Required Details
     website_name "your awesome site"
     website_url "https://example.com/healthcheck"
 
-    paused 0
-    # HTTP,TCP,PING
-    test_type "HTTP"
     contact_group ["Alarm"]
-    check_rate 300
-    timeout 40
-    website_host ""
-    node_locations ["freeserver2"]
+
+    # Scans
+    enable_ssl_warning 1
+
+    # HTTP Communication Options
     find_string ""
     do_not_find 0
-    logo_image ""
-
+    follow_redirect 1
     custom_header(
       {"Host"=>"example.com"}
     )
-    confirmation "2"
+    status_codes ["204", "205", "206", "303", "400", "401", "403", "404", "405", "406", "408", "410", "413", "444", "429", "494", "495", "496", "499", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511", "521", "522", "523", "524", "520", "598", "599", "302"]
 
-    basic_user nil
-    basic_pass nil
+    logo_image ""
 
-    use_jar nil
+    # Test Locations
+    node_locations ["freeserver11"]
 
-    dns_ip ""
-    dns_server ""
+    # Threshold Control
     trigger_rate "0"
+    confirmation "2"
+
+    # Additional Options
+    check_rate 300
+    timeout 40
     test_tags ["Web", "Internal"]
-    status_codes ["204", "205", "206", "303", "400", "401", "403", "404", "405", "406", "408", "410", "413", "444", "429", "494", "495", "496", "499", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511", "521", "522", "523", "524", "520", "598", "599", "302"]
-    enable_ssl_warning 0
-    follow_redirect 1
+    website_host ""
   end
 end
 ```
 
+## Secret provider
+
+If you don't want to commit your Basic authentication password, you can use SecretProvider.
+Use --secret-provider option to select provider.(e.g. --secret-provider=vault) Expression inside ${...} is passed to provider.
+
+```ruby
+  basic_user "username"
+  basic_pass "${password}"
+```
+
 ## Similar tools
 
 * [Codenize.tools](http://codenize.tools/)

data/lib/kashi/cli.rb

@@ -13,6 +13,8 @@ module Kashi
       @filepath = 'SCfile'
       @options = {
         color: true,
+        includes: [],
+        excludes: [],
       }
       parser.order!(@argv)
     end
@@ -37,9 +39,16 @@ module Kashi
         opts.on('-e', '--export', 'Export to DSL') { @export = true }
         opts.on('-n', '--dry-run', 'Dry run') { @options[:dry_run] = true }
         opts.on('',   '--no-color', 'No color') { @options[:color] = false }
+        opts.on('',   '--secret-provider NAME', 'use secret value expansion') { |v| @options[:secret_provider] = v }
         opts.on('-s', '--split', 'Split export DLS file contact group and tests') { @options[:split] = true }
         opts.on('',   '--split-more', 'Split export DLS file to 1 per object') { @options[:split_more] = true }
         opts.on('-v', '--debug', 'Show debug log') { Kashi.logger.level = Logger::DEBUG }
+        opts.on('-i', '--include-names NAMES', 'include website_name', Array) { |v| @options[:includes] = v }
+        opts.on('-x', '--exclude-names NAMES', 'exclude website_name by regex', Array) do |v|
+          @options[:excludes] = v.map! do |name|
+            name =~ /\A\/(.*)\/\z/ ? Regexp.new($1) : Regexp.new("\A#{Regexp.escape(name)}\z")
+          end
+        end
       end
     end
 

data/lib/kashi/client.rb

@@ -3,9 +3,11 @@ require 'kashi'
 require 'kashi/converter'
 require 'kashi/client_wrapper'
 require 'kashi/dsl'
+require 'kashi/filterable'
 
 module Kashi
   class Client
+    include Filterable
     MAGIC_COMMENT = <<-EOS
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
@@ -14,6 +16,7 @@ module Kashi
     def initialize(filepath, options = {})
       @filepath = filepath
       @options = options
+      @options[:secret_expander] = SecretExpander.new(@options[:secret_provider]) if @options[:secret_provider]
     end
 
     def traverse_contact_groups(dsl_contact_groups, sc_contact_groups_by_id, sc_contact_groups_by_name)
@@ -52,8 +55,9 @@ module Kashi
     end
 
     def traverse_tests(dsl_tests, sc_tests_by_id, sc_tests_by_name)
-      dsl_tests_by_name = dsl_tests.group_by(&:website_name)
-      dsl_tests_by_id = dsl_tests.group_by(&:test_id)
+      dsl_target_tests = dsl_tests.select { |t| target?(t.website_name) }
+      dsl_tests_by_name = dsl_target_tests.group_by(&:website_name)
+      dsl_tests_by_id = dsl_target_tests.group_by(&:test_id)
 
       # create
       dsl_tests_by_name.reject { |n, _| sc_tests_by_name[n] }.each do |name, dsl_tests|

data/lib/kashi/client_wrapper.rb

@@ -1,17 +1,24 @@
 require 'forwardable'
 require 'statuscake'
+require 'kashi/filterable'
 
 module Kashi
   class ClientWrapper
     extend Forwardable
+    include Filterable
 
-    def_delegators :@client, *%i/
+    def_delegators :@client, *%i(
       contactgroups contactgroups_update
-      tests tests_details tests_update
-    /
+      tests_details tests_update
+    )
 
     def initialize(options)
       @client = StatusCake::Client.new(API: ENV['KASHI_SC_API_KEY'], Username: ENV['KASHI_SC_USER'])
+      @options = options
+    end
+
+    def tests
+      @client.tests.select { |t| target?(t['WebsiteName']) }
     end
   end
 end

data/lib/kashi/dsl/test.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'kashi/secret_expander'
 
 module Kashi
   class DSL
@@ -8,17 +9,20 @@ module Kashi
           TestID Paused WebsiteName WebsiteURL Port NodeLocations Timeout CustomHeader Confirmation CheckRate
           DNSServer DNSIP BasicUser BasicPass LogoImage UseJar WebsiteHost Virus FindString DoNotFind
           TestType ContactGroup TriggerRate TestTags StatusCodes EnableSSLWarning FollowRedirect
+          PostRaw FinalEndpoint
         / # PingURL RealBrowser Public Branding
         ATTRIBUTES = %i/
           test_id paused website_name website_url port node_locations timeout custom_header confirmation check_rate
           dns_server dns_ip basic_user basic_pass logo_image use_jar website_host virus find_string do_not_find
           test_type contact_group trigger_rate test_tags status_codes enable_ssl_warning follow_redirect
+          post_raw final_endpoint
         / # ping_url real_browser public branding
         attr_accessor *ATTRIBUTES
 
         def initialize(context)
           @context = context
           @options = context.options
+          @options[:secret_expander] = SecretExpander.new(@options[:secret_provider]) if @options[:secret_provider]
         end
 
         def to_h
@@ -101,13 +105,23 @@ module Kashi
         def modify
           return unless updated?
           Kashi.logger.info("Modify Test `#{website_name}` #{test_id}")
-          Kashi.logger.info("<diff>\n#{Kashi::Utils.diff(sc_hash, dsl_hash, color: @options[:color])}")
+          masked_dsl_has = dsl_hash.dup.tap { |h| h[:basic_pass] = '****' }
+          Kashi.logger.info("<diff>\n#{Kashi::Utils.diff(sc_hash, masked_dsl_has, color: @options[:color])}")
           Kashi.logger.debug(modify_params)
           return if @options[:dry_run]
 
           client.tests_update(modify_params)
         end
 
+        def basic_pass
+          secret_expander = @options[:secret_expander]
+          if secret_expander
+            secret_expander.expand(@basic_pass)
+          else
+            @basic_pass
+          end
+        end
+
         def client
           @client ||= ClientWrapper.new(@options)
         end
@@ -139,6 +153,10 @@ module Kashi
         @result.status_codes = []
         @result.virus = ''
 
+        # not used
+        @result.post_raw = ''
+        @result.final_endpoint = ''
+
         instance_eval(&block)
       end
 

data/lib/kashi/filterable.rb

@@ -0,0 +1,20 @@
+module Kashi
+  module Filterable
+    def target?(website_name)
+      unless @options[:includes].empty?
+        unless @options[:includes].include?(website_name)
+          Kashi.logger.debug("skip website_name(with include-names option) #{website_name}")
+          return false
+        end
+      end
+
+      unless @options[:excludes].empty?
+        if @options[:excludes].any? { |regex| website_name =~ regex }
+          Kashi.logger.debug("skip website_name(with exclude-names option) #{website_name}")
+          return false
+        end
+      end
+      true
+    end
+  end
+end

data/lib/kashi/secret_expander.rb

@@ -0,0 +1,76 @@
+require 'strscan'
+
+module Kashi
+  class ExpansionError < StandardError
+  end
+
+  class SecretExpander
+    Literal = Struct.new(:literal)
+    Variable = Struct.new(:name)
+
+    def initialize(provider_name)
+      @provider = load_provider(provider_name)
+      @asked_variables = {}
+    end
+
+    def expand(str)
+      return str unless str
+      tokens = parse(str)
+      variables = Set.new
+      tokens.each do |token|
+        if token.is_a?(Variable)
+          unless @asked_variables.include?(token.name)
+            variables << token.name
+          end
+        end
+      end
+
+      unless variables.empty?
+        @provider.ask(variables).each do |k, v|
+          @asked_variables[k] = v
+        end
+      end
+
+      tokens.map do |token|
+        case token
+        when Literal
+          token.literal
+        when Variable
+          @asked_variables.fetch(token.name)
+        else
+          raise ExpansionError.new("Unknown token type: #{token.class}")
+        end
+      end.join
+    end
+
+    private
+
+    def parse(value)
+      s = StringScanner.new(value)
+      tokens = []
+      pos = 0
+      while s.scan_until(/\$\{(.*?)\}/)
+        pre = s.string.byteslice(pos...(s.pos - s.matched.size))
+        var = s[1]
+        unless pre.empty?
+          tokens << Literal.new(pre)
+        end
+        if var.empty?
+          raise ExpansionError.new('Empty interpolation is not allowed')
+        else
+          tokens << Variable.new(var)
+        end
+        pos = s.pos
+      end
+      unless s.rest.empty?
+        tokens << Literal.new(s.rest)
+      end
+      tokens
+    end
+
+    def load_provider(name)
+      require "kashi/secret_providers/#{name}"
+      Kashi::SecretProviders.const_get(name.split('_').map(&:capitalize).join('')).new
+    end
+  end
+end

data/lib/kashi/version.rb

@@ -1,3 +1,3 @@
 module Kashi
-  VERSION = '0.1.0.beta1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kashi
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - wata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statuscake
@@ -133,7 +133,9 @@ files:
 - lib/kashi/dsl/contact_group.rb
 - lib/kashi/dsl/test.rb
 - lib/kashi/ext/string-ext.rb
+- lib/kashi/filterable.rb
 - lib/kashi/output_test.erb
+- lib/kashi/secret_expander.rb
 - lib/kashi/utils.rb
 - lib/kashi/version.rb
 homepage: https://github.com/wata-gh/kashi
@@ -151,12 +153,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Codenize StatusCake