sambot 0.1.193 → 0.1.194

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a486880b0e4e4e6b34f652da8d07747bbf25f22a
-  data.tar.gz: addb33a7c2476d199dd03d521a00f0814d4ed6e3
+  metadata.gz: 4e665e26a7ff750db4a39687428a170cd4769111
+  data.tar.gz: '0835d78e1ecd8c1e9bbb5344d00a1783ebe87f82'
 SHA512:
-  metadata.gz: c70f2a08e33d87583e312c14f3b91118ded67cecc54fcdb4553a2f3146bbdd63432cda3df28762131085929298946ec6591e42ee80433405b1d53b26497874a8
-  data.tar.gz: 8220ce7fa20feed5cb0087c85a2663f700c10355c43b5264ed9f3bff105eab89f112b2e74a19e9043aea91f390ec2ce8952996e28b0bf1baced91974313f97a2
+  metadata.gz: f07be80b3513c861fabef6296877cd00c01d6926951856bbcabab2f663986a0e0593a78d027fa9d63e15e0441146cf25ebf98dae9ba4d3383b0dec98e4d9daab
+  data.tar.gz: fcd9b733f321e070bd35c060d031b3ac0a83b766a1210b3ef3c0007e3ddab40a4a725139aabff622efb29067a876e218041d10cf48087e95d575ac00a70f0cd2

data/README.md

@@ -1,20 +1,26 @@
 # Sambot
 
-Sambot is our internal Platform Engineering toolchain to help standardize and simplify our DevOps workflow.
+Sambot is our internal Platform Engineering toolchain to help standardize and
+simplify our DevOps workflow.
 
-It provides an executable with a variety of commands, grouped in various areas of functionality such as session management,
-DNS changes and cookbook management.
+It provides an executable with a variety of commands, grouped in various areas
+of functionality such as session management, DNS changes and cookbook management.
 
 ## Usage
 
-To install the gem, simply run `chef gem install sambot`. This will install the gem in your ChefDK installation.
+To install the gem, simply run `chef gem install sambot`. This will install the
+gem in your ChefDK installation. If you want to use it outside Chef,
+run `gem install sambot`.
 
-Run `chef exec sambot` to be shown the help menu. For help on specific commands, i.e. cookbook management and specific
-cookbook management commands, run `chef exec sambot help cookbook` or `chef exec sambot cookbook help generate` for example.
+Run `chef exec sambot` to be shown the help menu. For help on specific commands,
+i.e. cookbook management and specific cookbook management commands, run
+`chef exec sambot help cookbook` or `chef exec sambot cookbook help generate`
+for example.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.exacttarget.com/ads-devops/sambot.
+Bug reports and pull requests are welcome on GitHub at
+https://github.exacttarget.com/ads-devops/sambot.
 
 ### Installation
 
@@ -22,7 +28,8 @@ Make sure you have `ruby >= 2.4.0` installed.
 
 Install `bundler >= 1.15.1` by running `gem install bundler`
 
-Run `bundle install` from the root of the project to install the required ruby gems.
+Run `bundle install` from the root of the project to install the
+required Ruby gems.
 
 ### Running Sambot
 
@@ -30,9 +37,11 @@ If you want to test your changes locally, you can run `bundle exec bin/sambot`.
 
 ### Running Tests
 
-Run `bundle exec rspec spec`
+Run `bundle exec rspec spec` to execute the unit tests.
+
+Run `cd integration_tests && bundle exec rspec .` to execute the integration
+tests. These require that you have Docker Compose available. 
 
 ### Linting
 
 There is nothing here yet
-

data/integration_tests/vault_helper_spec.rb

@@ -22,28 +22,31 @@ RSpec.describe Sambot::Testing::VaultHelper do
     `docker-compose down`
   end
 
-  context ".setup()" do
+  context '.setup()' do
 
-    it "sets up Vault correctly" do
-      mounts= ::Vault.sys.mounts
+    it 'sets up Vault correctly' do
+      mounts = ::Vault.sys.mounts
       expect(mounts[:"dev/common"]).to_not be_nil
     end
 
   end
 
-  context ".generate_wrapped_token()" do
+  context '.generate_wrapped_token()' do
 
-    it "generates the correct token" do
+    it 'generates the correct token' do
       wrapped_token = VaultHelper.generate_wrapped_token
       access_token = ::Vault.logical.unwrap(wrapped_token)
       expect(access_token.auth.renewable?).to be true
       expect(access_token.auth.lease_duration).to eql(2764800)
     end
 
-    it "generates a renewable token" do
+    it 'generates a renewable token' do
       wrapped_token = VaultHelper.generate_wrapped_token
       access_token = ::Vault.logical.unwrap(wrapped_token)
-      ::Vault.auth_token.renew(access_token.auth.client_token)
+      ::Vault.configure do |config|
+        config.token = access_token.auth.client_token
+      end
+      ::Vault.auth_token.renew_self
     end
 
   end

data/lib/sambot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 require_relative 'sambot/application_error'

data/lib/sambot/application_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sambot
   class ApplicationError < RuntimeError
   end

data/lib/sambot/base_command.rb

@@ -11,12 +11,12 @@ class Thor
         paras = message.split("\n\n")
 
         paras.map! do |unwrapped|
-          unwrapped.strip.tr("\n", " ").squeeze(" ").gsub(/.{1,#{width}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n") }
+          unwrapped.strip.tr("\n", ' ').squeeze(' ').gsub(/.{1,#{width}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n") }
         end
 
         paras.each do |para|
           para.split("\n").each do |line|
-            stdout.puts line.insert(0, " " * indent)
+            stdout.puts line.insert(0, ' ' * indent)
           end
           stdout.puts unless para == paras.last
         end
@@ -41,39 +41,39 @@ class Thor
       command = all_commands[meth]
       handle_no_command_error(meth) unless command
       shell.say
-      shell.say("  Usage:", :green)
+      shell.say('  Usage:', :green)
       shell.say
       shell.say "  sambot #{command_name} "
       shell.say
       shell.say
       class_options_help(shell, nil => command.options.values)
-      shell.say "  Description:", :green
+      shell.say '  Description:', :green
       shell.say
-      shell.print_wrapped(docs("#{command_name}"), :indent => 2)
+      shell.print_wrapped(docs(command_name.to_s), indent: 2)
       shell.say
     end
   end
 end
 
 module Sambot
-    class BaseCommand < Thor
+  class BaseCommand < Thor
 
-      before :check_version
+    before :check_version
 
-      no_commands do
+    no_commands do
 
-        def execute()
-          Runtime.ensure_latest
-          yield
-        rescue ApplicationError => e
-          UI.error(e.message)
-        end
-
-        def self.docs(path)
-          File.read(File.join(File.dirname(__FILE__), '/docs', path + '.txt'))
-        end
+      def execute
+        Runtime.ensure_latest
+        yield
+      rescue ApplicationError => e
+        UI.error(e.message)
+      end
 
+      def self.docs(path)
+        File.read(File.join(File.dirname(__FILE__), '/docs', path + '.txt'))
       end
 
+    end
+
   end
 end

data/lib/sambot/chef/cookbook.rb

@@ -1,4 +1,4 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -7,16 +7,16 @@ module Sambot
     class Cookbook
 
       GENERATED_FILES = {
-        'teamcity.sh.erb': {eruby: true, dest: 'teamcity.sh', platform: [:windows, :centos]},
-        'chefignore': {eruby: false, dest: 'chefignore', platform: [:windows, :centos]},
-        'docker-compose.yml': {eruby: false, dest: 'docker-compose.yml', platform: [:windows, :centos]},
-        '.env': {eruby: false, dest: '.env', platform: [:windows, :centos]},
-        'Berksfile': {eruby: false, dest: 'Berksfile', platform: [:windows, :centos]},
-        '.rubocop.yml': {eruby: false, dest: '.rubocop.yml', platform: [:windows, :centos]},
-        '.gitignore.sample': {eruby: false, dest: '.gitignore', platform: [:windows, :centos]},
-        'Vagrantfile.erb': {eruby: false, dest: 'Vagrantfile.erb', platform: [:windows, :centos]},
-        'winrm_config': {eruby: false, dest: 'winrm_config', platform: [:windows]}
-      }
+        'teamcity.sh.erb': { eruby: true, dest: 'teamcity.sh', platform: %i[windows centos] },
+        'chefignore': { eruby: false, dest: 'chefignore', platform: %i[windows centos] },
+        'docker-compose.yml': { eruby: false, dest: 'docker-compose.yml', platform: %i[windows centos] },
+        '.env': { eruby: false, dest: '.env', platform: %i[windows centos] },
+        'Berksfile': { eruby: false, dest: 'Berksfile', platform: %i[windows centos] },
+        '.rubocop.yml': { eruby: false, dest: '.rubocop.yml', platform: %i[windows centos] },
+        '.gitignore.sample': { eruby: false, dest: '.gitignore', platform: %i[windows centos] },
+        'Vagrantfile.erb': { eruby: false, dest: 'Vagrantfile.erb', platform: %i[windows centos] },
+        'winrm_config': { eruby: false, dest: 'winrm_config', platform: %i[windows] }
+      }.freeze
 
       class << self
 
@@ -25,18 +25,18 @@ module Sambot
           Generator.from_templates(config, cloud, local_workflow, GENERATED_FILES)
           Kitchen.setup(cloud, config, local_workflow)
           Metadata.generate(config)
-          Hooks.copy()
+          Hooks.copy
           UI.info('The cookbook has been successfully built.')
         end
 
-        def bump()
+        def bump
           new_version = Config.bump_version
           UI.info("You have bumped the version of this cookbook to #{new_version}.")
         end
 
-        def clean()
+        def clean
           UI.info('Removing all generated files from this cookbook.')
-          targets = GENERATED_FILES.map{ |key, val| val[:dest]} - ['.gitignore']
+          targets = GENERATED_FILES.map { |_, val| val[:dest] } - ['.gitignore']
           targets.each { |file| Sambot::FS.delete(file) }
           Sambot::FS.delete('bootstrap.sh')
           Sambot::FS.delete('bootstrap.ps1')
@@ -58,16 +58,16 @@ module Sambot
 
         def create_files(config)
           ['README.md'].each { |resource| FS.copy(resource) unless FS.exist?(resource) }
-          ['spec', 'test', 'attributes', 'local_testing'].each { |resource| FS.mkdir(resource) unless FS.exist?(resource) }
+          %w[spec test attributes local_testing].each { |resource| FS.mkdir(resource) unless FS.exist?(resource) }
           Dir.chdir('attributes') { FileUtils.touch('default.rb') unless FS.exist?('default.rb') }
           Dir.chdir('spec') { FS.copy('spec_helper.rb') unless FS.exist?('spec_helper.rb') }
-          ['recipes', 'libraries', 'resources', 'files', 'templates'].each { |target| FS.mkdir(target) unless FS.exist?(target) }
+          %w[recipes libraries resources files templates].each { |target| FS.mkdir(target) unless FS.exist?(target) }
           Dir.chdir('recipes') do
             FileUtils.touch('default.rb') unless FS.exist?('default.rb')
           end
           unless FS.exist?('.config.yml')
-            Template.new('.config.yml.erb').write({config: config}, '.config.yml')
-            UI.debug("./.config.yml has been added to the cookbook.")
+            Template.new('.config.yml.erb').write({ config: config }, '.config.yml')
+            UI.debug('./.config.yml has been added to the cookbook.')
           end
         end
 

data/lib/sambot/chef/generator.rb

@@ -1,58 +1,59 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
+
 require 'awesome_print'
 
 module Sambot
-    module Chef
-      class Generator
-
-        def self.from_templates(config, cloud, local_workflow, generated_files)
-          generated_files.each { |template_name, opts| generate_from_template(template_name.to_s, opts, config) }
-          generate_bootstrap_scripts(config, cloud, local_workflow)
-        end
+  module Chef
+    class Generator
 
-        private
+      def self.from_templates(config, cloud, local_workflow, generated_files)
+        generated_files.each { |template_name, opts| generate_from_template(template_name.to_s, opts, config) }
+        generate_bootstrap_scripts(config, cloud, local_workflow)
+      end
 
-        def self.bootstrap_centos(path)
-          generate_bootstrap_from_template('bootstrap.sh', path, 'sh')
-        end
+      private_class_method
 
-        def self.bootstrap_windows(path)
-          generate_bootstrap_from_template('bootstrap.ps1', path, 'ps1')
-        end
+      def self.bootstrap_centos(path)
+        generate_bootstrap_from_template(path, 'sh')
+      end
 
-        def self.bootstrap(config, path)
-          bootstrap_centos(path) if config.runs_on_centos?
-          bootstrap_windows(path) if config.runs_on_windows?
-        end
+      def self.bootstrap_windows(path)
+        generate_bootstrap_from_template(path, 'ps1')
+      end
 
-        def self.generate_bootstrap_from_template(dest, path, suffix)
-          Template.new("bootstrap_scripts/#{path}/bootstrap.#{suffix}.erb").process({eruby: true, dest: "bootstrap.#{suffix}"})
-        end
+      def self.bootstrap(config, path)
+        bootstrap_centos(path) if config.runs_on_centos?
+        bootstrap_windows(path) if config.runs_on_windows?
+      end
 
-        def self.generate_bootstrap_scripts(config, cloud, local_workflow)
-          cloud != 'local'? bootstrap(config, cloud) : bootstrap(config, "local/#{local_workflow}")
-        end
+      def self.generate_bootstrap_from_template(path, suffix)
+        Template.new("bootstrap_scripts/#{path}/bootstrap.#{suffix}.erb").process(eruby: true, dest: "bootstrap.#{suffix}")
+      end
 
-        def self.exists!(path)
-          return if File.exist?(path) || Dir.exist?(path)
-          raise ApplicationError, "The file or directory #{path} was not found in the current directory."
-        end
+      def self.generate_bootstrap_scripts(config, cloud, local_workflow)
+        cloud != 'local' ? bootstrap(config, cloud) : bootstrap(config, "local/#{local_workflow}")
+      end
 
-        def self.generate_from_template(template_file, opts, config)
-          UI.debug("Processing #{template_file} with opts #{opts.inspect} on platform #{config.available_platforms}")
-          template = Template.new(template_file)
-          if valid_platform?(opts, config)
-            template.process(opts)
-            UI.debug("#{opts[:dest]} has been added to the cookbook.")
-          end
-        end
+      def self.exists!(path)
+        return if File.exist?(path) || Dir.exist?(path)
+        raise ApplicationError, "The file or directory #{path} was not found in the current directory."
+      end
 
-        def self.valid_platform?(opts, config)
-          targets = opts[:platform].map { |x| x.to_s}
-          result = targets & config.available_platforms
-          result.size > 0
+      def self.generate_from_template(template_file, opts, config)
+        UI.debug("Processing #{template_file} with opts #{opts.inspect} on platform #{config.available_platforms}")
+        template = Template.new(template_file)
+        if valid_platform?(opts, config)
+          template.process(opts)
+          UI.debug("#{opts[:dest]} has been added to the cookbook.")
         end
+      end
 
+      def self.valid_platform?(opts, config)
+        targets = opts[:platform].map(&:to_s)
+        result = targets & config.available_platforms
+        result.size.positive?
       end
+
+    end
   end
 end

data/lib/sambot/chef/hooks.rb

@@ -1,21 +1,21 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 module Sambot
-    module Chef
-      class Hooks
+  module Chef
+    class Hooks
 
-        SCRIPTS = ['pre-push', 'pre-commit']
+      SCRIPTS = ['pre-push', 'pre-commit'].freeze
 
-        def self.copy
-          SCRIPTS.each do |hook|
-            working_path = ".git/hooks/#{hook}"
-            template_path = Template.new("git_hooks/#{hook}").path
-            File.delete(working_path) if File.exist?(working_path)
-            FileUtils.cp(template_path, working_path)
-            UI.debug("The #{hook} Git hook has been added to the cookbook.")
-          end
+      def self.copy
+        SCRIPTS.each do |hook|
+          working_path = ".git/hooks/#{hook}"
+          template_path = Template.new("git_hooks/#{hook}").path
+          File.delete(working_path) if File.exist?(working_path)
+          FileUtils.cp(template_path, working_path)
+          UI.debug("The #{hook} Git hook has been added to the cookbook.")
         end
-
       end
+
+    end
   end
 end

data/lib/sambot/chef/kitchen.rb

@@ -1,67 +1,67 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 module Sambot
-    module Chef
-      class Kitchen
+  module Chef
+    class Kitchen
 
-        class << self
+      class << self
 
-          GENERATED_FILE = '.kitchen.yml'
+        GENERATED_FILE = '.kitchen.yml'
 
-          def setup(cloud, config, vault_setup)
-            contents = generate_yml(cloud, config.name, config.available_platforms, config.suites, vault_setup)
-            File.write(GENERATED_FILE, contents)
-            UI.debug("#{GENERATED_FILE} has been added to the cookbook.")
-          end
+        def setup(cloud, config, vault_setup)
+          contents = generate_yml(cloud, config.name, config.available_platforms, config.suites, vault_setup)
+          File.write(GENERATED_FILE, contents)
+          UI.debug("#{GENERATED_FILE} has been added to the cookbook.")
+        end
 
-          def clean
-            FS.delete(GENERATED_FILE)
-          end
+        def clean
+          FS.delete(GENERATED_FILE)
+        end
 
-          def generate_yml(cloud, cookbook_name, platforms, suites = nil, vault_setup = nil)
-            raise ApplicationError, 'Missing platforms when trying to generate Test-Kitchen YAML.' unless platforms
-            raise ApplicationError, 'Missing cookbook name when trying to generate Test-Kitchen YAML.' unless cookbook_name
-            template = read_template(cloud, cookbook_name, platforms, vault_setup)
-            if suites
-              template['suites'] = Marshal.load(Marshal.dump(suites))
-              add_platform_identifier(template, cloud)
-            end
-            template.to_yaml
+        def generate_yml(cloud, cookbook_name, platforms, suites = nil, vault_setup = nil)
+          raise ApplicationError, 'Missing platforms when trying to generate Test-Kitchen YAML.' unless platforms
+          raise ApplicationError, 'Missing cookbook name when trying to generate Test-Kitchen YAML.' unless cookbook_name
+          template = read_template(cloud, cookbook_name, platforms, vault_setup)
+          if suites
+            template['suites'] = Marshal.load(Marshal.dump(suites))
+            add_platform_identifier(template, cloud)
           end
+          template.to_yaml
+        end
 
-          private
+        private
 
-          # Adds attributes to each test suite that is only applicable to testing
-          # environments. These are things like controlling how Vault token
-          # renewal works and specifying the cloud platform.
-          def add_platform_identifier(value, platform)
-            value['suites'].each do |suite|
-              suite['run_list'] = handle_customized_runlists(suite, platform)
-              # Changes to <platform> below to keep compatibility with existing cookbooks
-              platform = 'LOCAL' if platform == 'local'
-              platform = 'GCP' if platform == 'google'
-              platform = 'RACKSPACE' if platform == 'rackspace'
-              suite['attributes'] = suite['attributes'] || {}
-              suite['attributes']['cloud_platform'] = platform
-              suite['attributes']['vault'] = suite['attributes']['vault'] || {}
-              suite['attributes']['vault']['exec_renew'] = false
-            end
+        # Adds attributes to each test suite that is only applicable to testing
+        # environments. These are things like controlling how Vault token
+        # renewal works and specifying the cloud platform.
+        def add_platform_identifier(value, platform)
+          value['suites'].each do |suite|
+            suite['run_list'] = handle_customized_runlists(suite, platform)
+            # Changes to <platform> below to keep compatibility with existing cookbooks
+            platform = 'LOCAL' if platform == 'local'
+            platform = 'GCP' if platform == 'google'
+            platform = 'RACKSPACE' if platform == 'rackspace'
+            suite['attributes'] = suite['attributes'] || {}
+            suite['attributes']['cloud_platform'] = platform
+            suite['attributes']['vault'] = suite['attributes']['vault'] || {}
+            suite['attributes']['vault']['exec_renew'] = false
           end
+        end
 
-          # Provides the ability to have a different run-list for different clouds.
-          # This only works for the 'local' cloud and the 'dev' clouds i.e. Rackspace
-          # and Google.
-          def handle_customized_runlists(config, platform)
-            runlist = config['run_list']
-            return runlist if runlist.is_a?(Array)
-            platform == 'local' ? runlist['local'] : runlist['dev']
-          end
+        # Provides the ability to have a different run-list for different clouds.
+        # This only works for the 'local' cloud and the 'dev' clouds i.e. Rackspace
+        # and Google.
+        def handle_customized_runlists(config, platform)
+          runlist = config['run_list']
+          return runlist if runlist.is_a?(Array)
+          platform == 'local' ? runlist['local'] : runlist['dev']
+        end
 
-          def read_template(cloud, cookbook_name, platforms, vault_setup)
-            ctx = {platforms: platforms, name: cookbook_name, vault_setup: vault_setup}
-            result = Template.new("test_kitchen/#{cloud}.yml.erb").evaluate(ctx, {:pattern => '<!--% %-->'})
-            YAML.load(result)
-          end
+        def read_template(cloud, cookbook_name, platforms, vault_setup)
+          ctx = { platforms: platforms, name: cookbook_name, vault_setup: vault_setup }
+          result = Template.new("test_kitchen/#{cloud}.yml.erb").evaluate(ctx, pattern: '<!--% %-->')
+          YAML.safe_load(result)
+        end
 
       end
     end

data/lib/sambot/chef/metadata.rb

@@ -1,4 +1,4 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 require 'erubis'
 
@@ -8,7 +8,7 @@ module Sambot
 
       class << self
 
-        GENERATED_FILES = ['metadata.rb', 'Berksfile.lock']
+        GENERATED_FILES = ['metadata.rb', 'Berksfile.lock'].freeze
 
         def clean
           GENERATED_FILES.each do |filename|
@@ -23,15 +23,15 @@ module Sambot
             'cookbook_version' => config.version,
             'cookbook_description' => config.description,
             'cookbook_dependencies' => config.dependencies,
-            'cookbook_gems' => config.gems,
+            'cookbook_gems' => config.gems
           }, dest)
         end
 
         private
 
         def write(ctx, dest)
-          template = Sambot::Template.new('metadata.rb.erb').write(ctx, dest)
-          UI.debug("A new metadata.rb file has been generated.")
+          Sambot::Template.new('metadata.rb.erb').write(ctx, dest)
+          UI.debug('A new metadata.rb file has been generated.')
         end
 
       end

data/lib/sambot/chef/server.rb

@@ -1,58 +1,58 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 require 'ridley'
 require 'json'
 
 module Sambot
-    module Chef
-      class Server
-
-        SHORT_NAMES = {
-          'wsus' => 'WSUS',
-          'nginx-proxy' => 'PRXY',
-          'jetstream' => 'JTS',
-          'task-scheduler' => 'TASKS',
-          'queue-service' => 'QUE',
-          'skylight' => 'SKY',
-          'prometheus' => 'PRT',
-          'octopus' => 'OCTO',
-          'vault' => 'VAULT',
-          'consul' => 'CONSUL',
-          'rabbitmq' => 'RMQ',
-          'etcd' => 'ETCD',
-          'teamcity-agent' => 'TCA',
-          'teamcity-server' => 'TCS',
-          'bastion' =>   'BST',
-          'base' => 'BASE',
-          'grafana' => 'MON'
-        }
-
-        def initialize(ridley = nil)
-          @ridley = ridley || Ridley.new(
-            server_url: "https://chef.brighter.io/organizations/#{ENV['CHEF_ORGANIZATION']}",
-            client_name: ENV['CHEF_CLIENT_NAME'],
-            client_key: ENV['CHEF_CLIENT_KEY'],
-            proxy: ENV['FIXIE_URL']
-          )
-        end
+  module Chef
+    class Server
+
+      SHORT_NAMES = {
+        'wsus' => 'WSUS',
+        'nginx-proxy' => 'PRXY',
+        'jetstream' => 'JTS',
+        'task-scheduler' => 'TASKS',
+        'queue-service' => 'QUE',
+        'skylight' => 'SKY',
+        'prometheus' => 'PRT',
+        'octopus' => 'OCTO',
+        'vault' => 'VAULT',
+        'consul' => 'CONSUL',
+        'rabbitmq' => 'RMQ',
+        'etcd' => 'ETCD',
+        'teamcity-agent' => 'TCA',
+        'teamcity-server' => 'TCS',
+        'bastion' =>   'BST',
+        'base' => 'BASE',
+        'grafana' => 'MON'
+      }.freeze
+
+      def initialize(ridley = nil)
+        @ridley = ridley || Ridley.new(
+          server_url: "https://chef.brighter.io/organizations/#{ENV['CHEF_ORGANIZATION']}",
+          client_name: ENV['CHEF_CLIENT_NAME'],
+          client_key: ENV['CHEF_CLIENT_KEY'],
+          proxy: ENV['FIXIE_URL']
+        )
+      end
 
-        def cookbooks
-          @cookbooks ||= @ridley.cookbook.all.select {|x| x =~ /as-/}.keys.sort
-        end
+      def cookbooks
+        @cookbooks ||= @ridley.cookbook.all.select { |x| x =~ /as-/ }.keys.sort
+      end
 
-        def roles
-          cookbooks.select {|x| x =~ /role/}
-        end
+      def roles
+        cookbooks.select { |x| x =~ /role/ }
+      end
 
-        def find_role_name(cookbook)
-          naive_name = cookbook.gsub(/as-role-/, '').gsub(/as-app-role-/, '')
-          if SHORT_NAMES.key?(naive_name)
-            SHORT_NAMES[naive_name]
-          else
-            raise 'Could not generate an instance name'
-          end
+      def find_role_name(cookbook)
+        naive_name = cookbook.gsub(/as-role-/, '').gsub(/as-app-role-/, '')
+        if SHORT_NAMES.key?(naive_name)
+          SHORT_NAMES[naive_name]
+        else
+          raise 'Could not generate an instance name'
         end
-
       end
+
     end
   end
+end

data/lib/sambot/cli.rb

@@ -7,7 +7,7 @@ module Sambot
 
     desc 'clean', 'Remove all generated build files from a Chef cookbook'
     def clean
-      execute { Chef::Cookbook.clean() }
+      execute { Chef::Cookbook.clean }
     end
 
     desc 'populate', 'Populates Vault and Consul with seed data'
@@ -21,14 +21,14 @@ module Sambot
 
     desc 'bump', 'Bump the patch version of a cookbook'
     def bump
-      execute { Chef::Cookbook.bump() }
+      execute { Chef::Cookbook.bump }
     end
 
     desc 'build', 'Builds a Chef cookbook from its configuration file'
-    option :local, :type => :boolean
-    option :google, :type => :boolean
-    option :rackspace, :type => :boolean
-    option :docker, :type => :boolean
+    option :local, type: :boolean
+    option :google, type: :boolean
+    option :rackspace, type: :boolean
+    option :docker, type: :boolean
     def build
       execute do
         cloud = nil
@@ -49,19 +49,19 @@ module Sambot
       execute do
         opts = {
           name: ask(' What is the name of this cookbook?'),
-          type: ask(' What type of cookbook will this be?', :limited_to => ['wrapper', 'role']),
-          platforms: ask(' What operating system will this cookbook run on?', :limited_to => ['windows', 'centos', 'both']),
+          type: ask(' What type of cookbook will this be?', limited_to: %w[wrapper role]),
+          platforms: ask(' What operating system will this cookbook run on?', limited_to: %w[windows centos both]),
           description: ask(' What does this cookbook do?')
         }
         opts[:identifier] = ask(' What will be the unique machiner identifier for this role cookbook i.e. TCA (TeamCity Agent) or RMQ (RabbitMQ role)?') if opts[:type] == 'role'
-        opts[:platforms] = opts[:platforms] == 'both' ? ['centos', 'windows'] : [opts[:platforms]]
+        opts[:platforms] = opts[:platforms] == 'both' ? %w[centos windows] : [opts[:platforms]]
         Chef::Cookbook.create(Config.new(opts))
       end
     end
 
     desc 'version', 'Gives the cookbook version as a TeamCity service message'
     def version
-      execute { puts "##teamcity[buildNumber '#{Config.read.version.to_s}']" }
+      execute { puts "##teamcity[buildNumber '#{Config.read.version}']" }
     end
 
   end

data/lib/sambot/config.rb

@@ -4,94 +4,94 @@ require 'yaml'
 require 'semantic'
 
 module Sambot
-      class Config
-
-        CONFIGURATION_FILENAME = '.config.yml'.freeze
-
-        def self.bump_version(path = nil)
-          path ||= File.join(Dir.getwd, CONFIGURATION_FILENAME)
-          config = YAML.load_file(path)
-          version = config['version']
-          config['version'] = bump(version)
-          File.write(path, YAML.dump(config))
-          config['version']
-        end
-
-        def initialize(opts)
-          @opts = opts
-        end
-
-        def self.read(path = nil)
-          path ||= File.join(Dir.getwd, CONFIGURATION_FILENAME)
-          raise ApplicationError, "The configuration file was not found at #{path}." unless File.exist?(path)
-          config = YAML.load_file(path)
-          raise ApplicationError, 'Missing cookbook name in the .config.yml configuration file' unless config['name']
-          raise ApplicationError, 'Missing platforms in the .config.yml configuration file' unless config['platform'] || config['platforms']
-          raise ApplicationError, 'Missing version in the .config.yml configuration file' unless config['version']
-          raise ApplicationError, 'Missing list of suites in the .config.yml configuration file' unless config['suites']
-          raise ApplicationError, 'Missing description in the .config.yml configuration file' unless config['description']
-          # Dealing with legacy tech debt of allowing multiple platforms rather than a single platform
-          unless config['platforms']
-            unless config['platform'].kind_of?(Array)
-              config['platform'] = [config['platform']]
-            end
-            config['platforms'] = config['platform']
-          end
-          Config.new(config)
+  class Config
+
+    CONFIGURATION_FILENAME = '.config.yml'
+
+    def self.bump_version(path = nil)
+      path ||= File.join(Dir.getwd, CONFIGURATION_FILENAME)
+      config = YAML.load_file(path)
+      version = config['version']
+      config['version'] = bump(version)
+      File.write(path, YAML.dump(config))
+      config['version']
+    end
+
+    def initialize(opts)
+      @opts = opts
+    end
+
+    def self.read(path = nil)
+      path ||= File.join(Dir.getwd, CONFIGURATION_FILENAME)
+      raise ApplicationError, "The configuration file was not found at #{path}." unless File.exist?(path)
+      config = YAML.load_file(path)
+      raise ApplicationError, 'Missing cookbook name in the .config.yml configuration file' unless config['name']
+      raise ApplicationError, 'Missing platforms in the .config.yml configuration file' unless config['platform'] || config['platforms']
+      raise ApplicationError, 'Missing version in the .config.yml configuration file' unless config['version']
+      raise ApplicationError, 'Missing list of suites in the .config.yml configuration file' unless config['suites']
+      raise ApplicationError, 'Missing description in the .config.yml configuration file' unless config['description']
+      # Dealing with legacy tech debt of allowing multiple platforms rather than a single platform
+      unless config['platforms']
+        unless config['platform'].is_a?(Array)
+          config['platform'] = [config['platform']]
         end
+        config['platforms'] = config['platform']
+      end
+      Config.new(config)
+    end
 
-        def available_platforms
-          platforms = @opts[:platforms] if @opts.has_key?(:platforms)
-          platforms = @opts['platforms'] if @opts.has_key?('platforms')
-          platforms
-        end
+    def available_platforms
+      platforms = @opts[:platforms] if @opts.key?(:platforms)
+      platforms = @opts['platforms'] if @opts.key?('platforms')
+      platforms
+    end
 
-        def gems
-          @opts['gems'] || @opts[:gems] || []
-        end
+    def gems
+      @opts['gems'] || @opts[:gems] || []
+    end
 
-        def dependencies
-          items = @opts['dependencies'] || @opts[:dependencies]
-          items ? items.map { |x| transform_hashes(x) } : []
-        end
+    def dependencies
+      items = @opts['dependencies'] || @opts[:dependencies]
+      items ? items.map { |x| transform_hashes(x) } : []
+    end
 
-        def dependencies=(value)
-          @opts['dependencies'] = value
-        end
+    def dependencies=(value)
+      @opts['dependencies'] = value
+    end
 
-        def transform_hashes(obj)
-          obj.is_a?(Hash) ? "#{obj.keys.first}', '#{obj.values.first}" : obj
-        end
+    def transform_hashes(obj)
+      obj.is_a?(Hash) ? "#{obj.keys.first}', '#{obj.values.first}" : obj
+    end
 
-        def description; @opts['description']; end
+    def description; @opts['description']; end
 
-        def identifier; @opts['identifier']; end
+    def identifier; @opts['identifier']; end
 
-        def suites; @opts['suites']; end
+    def suites; @opts['suites']; end
 
-        def version; @opts['version']; end
+    def version; @opts['version']; end
 
-        def secrets; @opts.dig('local_testing', 'secrets') || []; end
+    def secrets; @opts.dig('local_testing', 'secrets') || []; end
 
-        def name; @opts['name']; end
+    def name; @opts['name']; end
 
-        def runs_on_centos?
-          available_platforms.include?('centos')
-        end
+    def runs_on_centos?
+      available_platforms.include?('centos')
+    end
 
-        def runs_on_windows?
-          available_platforms.include?('windows')
-        end
+    def runs_on_windows?
+      available_platforms.include?('windows')
+    end
 
-        private
+    private_class_method
 
-        def self.bump(version)
-          UI.debug("Old cookbook version: #{version}")
-          version_info = Semantic::Version.new version
-          new_version = "#{version_info.major}.#{version_info.minor}.#{version_info.patch + 1}"
-          UI.debug("Old cookbook version: #{new_version}")
-          new_version
-        end
+    def self.bump(version)
+      UI.debug("Old cookbook version: #{version}")
+      version_info = Semantic::Version.new version
+      new_version = "#{version_info.major}.#{version_info.minor}.#{version_info.patch + 1}"
+      UI.debug("Old cookbook version: #{new_version}")
+      new_version
+    end
 
-      end
+  end
 end

data/lib/sambot/runtime.rb

@@ -5,18 +5,16 @@ require 'gems'
 module Sambot
   module Runtime
 
-    def self.is_obsolete
-      latest_version = Gems.new.versions('sambot')[0]["number"]
+    def self.obsolete?
+      latest_version = Gems.new.versions('sambot')[0]['number']
       Gem::Version.new(Sambot::VERSION) < Gem::Version.new(latest_version)
     end
 
     def self.ensure_latest
-      latest_version = Gems.new.versions('sambot')[0]["number"]
+      latest_version = Gems.new.versions('sambot')[0]['number']
       UI.debug("Current version is #{Sambot::VERSION}")
       UI.debug("Latest version is #{latest_version}")
-      if is_obsolete
-        UI.info('A newer version of this gem exists - please update the gem before continuing')
-      end
+      UI.info('A newer version of this gem exists - please update the gem before continuing') if obsolete?
     end
 
   end

data/lib/sambot/template.rb

@@ -21,12 +21,12 @@ module Sambot
     def process(opts)
       File.delete(opts[:dest]) if File.exist?(opts[:dest])
       if opts[:eruby]
-        UI.debug("Parsing #{self.path} using Erubis")
-        self.write(opts, opts[:dest])
+        UI.debug("Parsing #{path} using Erubis")
+        write(opts, opts[:dest])
       else
-        FileUtils.cp(self.path, opts[:dest].to_s)
+        FileUtils.cp(path, opts[:dest].to_s)
       end
-      if File.executable?(self.path)
+      if File.executable?(path)
         UI.debug("Making #{opts[:dest]} executable")
         make_executable(opts[:dest])
       end
@@ -40,7 +40,7 @@ module Sambot
     private
 
     def make_executable(working_path)
-      current_mask = File.stat(self.path).mode
+      current_mask = File.stat(path).mode
       new_mask = current_mask | '0000000000000001'.to_i(2)
       File.chmod(new_mask, working_path)
     end

data/lib/sambot/templates/Berksfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source :chef_server
 source 'https://supermarket.chef.io'
 

data/lib/sambot/templates/spec_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'chefspec'
 require 'chefspec/berkshelf'

data/lib/sambot/testing/consul_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Sambot
   module Testing

data/lib/sambot/testing/fixtures.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Sambot
   module Testing

data/lib/sambot/testing/vault_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'vault'
 require 'fileutils'
@@ -20,7 +22,8 @@ module Sambot
           end
           token = ''
           begin
-            token = Vault.auth_token.create('wrap_ttl': "72h", role: 'nightswatch-ro', policies: ['nightswatch-ro']).wrap_info.token
+            wrap_info = Vault.auth_token.create('wrap_ttl': '72h', role: 'nightswatch-ro', policies: ['nightswatch-ro']).wrap_info
+            token = wrap_info.token
           rescue
           end
           token
@@ -31,21 +34,21 @@ module Sambot
           FileUtils.mkpath WORKING_DIR
           UI.info("Created #{WORKING_DIR}")
           Dir.chdir WORKING_DIR do
-            UI.info("Cloning the Vault policies for inclusion into the Vault Docker instance")
+            UI.info('Cloning the Vault policies for inclusion into the Vault Docker instance')
             `git clone --depth=1 --single-branch -q #{VAULT_POLICIES_REPO}`
             Dir.chdir 'vault-policies/dev/vault-config' do
               FS.copy(VAULT_CONFIG_BINARY)
-              UI.info("Applying the Vault policies")
+              UI.info('Applying the Vault policies')
               `VC_VAULT_ADDR=http://127.0.0.1:8200 VC_VAULT_TOKEN=root ./#{VAULT_CONFIG_BINARY} config`
-              UI.info("The Vault policies have been applied")
+              UI.info('The Vault policies have been applied')
             end
           end
         end
 
         def load_secrets(config, src = 'local_testing')
-          UI.info("Reading secrets from the configuration file")
+          UI.info('Reading secrets from the configuration file')
           if config.secrets.nil? || config.secrets.empty?
-            UI.info("No secrets were found in the secrets configuration file")
+            UI.info('No secrets were found in the secrets configuration file')
             return 0
           else
             store_secrets(config.secrets, src)
@@ -59,7 +62,7 @@ module Sambot
           secrets.each do |secret|
             secret['keys'].each do |item|
               store_secret(src, secret['path'], item.keys[0], item.values[0])
-              counter = counter + 1
+              counter += 1
             end
           end
           counter
@@ -76,7 +79,7 @@ module Sambot
         end
 
         def write_to_vault(path, key, value)
-          Vault.logical.write(path, "#{key}".to_sym => value)
+          Vault.logical.write(path, key.to_sym => value)
         end
 
       end

data/lib/sambot/ui.rb

@@ -1,41 +1,41 @@
 # frozen_string_literal: true
 
 module Sambot
-      module UI
+  module UI
 
-        @@silent = false
+    @@silent = false
 
-        def self.silent=(value)
-          @@silent = value
-        end
+    def self.silent=(value)
+      @@silent = value
+    end
 
-        def self.ask(msg)
-          Thor.new.ask(msg) unless @@silent
-        end
+    def self.ask(msg)
+      Thor.new.ask(msg) unless @@silent
+    end
 
-        def self.ask_password(msg)
-          Thor.new.ask(msg, :echo => false) unless @@silent
-        end
+    def self.ask_password(msg)
+      Thor.new.ask(msg, echo: false) unless @@silent
+    end
 
-        def self.warn(msg)
-          date_format = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
-          Thor.new.say("#{date_format} [W] #{msg}", :yellow) unless @@silent
-        end
+    def self.warn(msg)
+      date_format = DateTime.now.strftime('%Y-%m-%d %H:%M:%S')
+      Thor.new.say("#{date_format} [W] #{msg}", :yellow) unless @@silent
+    end
 
-        def self.debug(msg)
-          date_format = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
-          Thor.new.say("#{date_format} [D] #{msg}", :gray) unless @@silent
-        end
+    def self.debug(msg)
+      date_format = DateTime.now.strftime('%Y-%m-%d %H:%M:%S')
+      Thor.new.say("#{date_format} [D] #{msg}", :gray) unless @@silent
+    end
 
-        def self.info(msg)
-          date_format = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
-          Thor.new.say("#{date_format} [I] #{msg}", :green) unless @@silent
-        end
+    def self.info(msg)
+      date_format = DateTime.now.strftime('%Y-%m-%d %H:%M:%S')
+      Thor.new.say("#{date_format} [I] #{msg}", :green) unless @@silent
+    end
 
-        def self.error(msg)
-          date_format = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
-          Thor.new.say("#{date_format} [E] #{msg}", :red) unless @@silent
-        end
+    def self.error(msg)
+      date_format = DateTime.now.strftime('%Y-%m-%d %H:%M:%S')
+      Thor.new.say("#{date_format} [E] #{msg}", :red) unless @@silent
+    end
 
-      end
   end
+end

data/lib/sambot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sambot
-  VERSION = '0.1.193'.freeze
+  VERSION = '0.1.194'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sambot
 version: !ruby/object:Gem::Version
-  version: 0.1.193
+  version: 0.1.194
 platform: ruby
 authors:
 - Olivier Kouame
@@ -330,45 +330,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |+
-  # Sambot
-
-  Sambot is our internal Platform Engineering toolchain to help standardize and simplify our DevOps workflow.
-
-  It provides an executable with a variety of commands, grouped in various areas of functionality such as session management,
-  DNS changes and cookbook management.
-
-  ## Usage
-
-  To install the gem, simply run `chef gem install sambot`. This will install the gem in your ChefDK installation.
-
-  Run `chef exec sambot` to be shown the help menu. For help on specific commands, i.e. cookbook management and specific
-  cookbook management commands, run `chef exec sambot help cookbook` or `chef exec sambot cookbook help generate` for example.
-
-  ## Contributing
-
-  Bug reports and pull requests are welcome on GitHub at https://github.exacttarget.com/ads-devops/sambot.
-
-  ### Installation
-
-  Make sure you have `ruby >= 2.4.0` installed.
-
-  Install `bundler >= 1.15.1` by running `gem install bundler`
-
-  Run `bundle install` from the root of the project to install the required ruby gems.
-
-  ### Running Sambot
-
-  If you want to test your changes locally, you can run `bundle exec bin/sambot`.
-
-  ### Running Tests
-
-  Run `bundle exec rspec spec`
-
-  ### Linting
-
-  There is nothing here yet
-
+description: "# Sambot\n\nSambot is our internal Platform Engineering toolchain to
+  help standardize and\nsimplify our DevOps workflow.\n\nIt provides an executable
+  with a variety of commands, grouped in various areas\nof functionality such as session
+  management, DNS changes and cookbook management.\n\n## Usage\n\nTo install the gem,
+  simply run `chef gem install sambot`. This will install the\ngem in your ChefDK
+  installation. If you want to use it outside Chef,\nrun `gem install sambot`.\n\nRun
+  `chef exec sambot` to be shown the help menu. For help on specific commands,\ni.e.
+  cookbook management and specific cookbook management commands, run\n`chef exec sambot
+  help cookbook` or `chef exec sambot cookbook help generate`\nfor example.\n\n##
+  Contributing\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.exacttarget.com/ads-devops/sambot.\n\n###
+  Installation\n\nMake sure you have `ruby >= 2.4.0` installed.\n\nInstall `bundler
+  >= 1.15.1` by running `gem install bundler`\n\nRun `bundle install` from the root
+  of the project to install the\nrequired Ruby gems.\n\n### Running Sambot\n\nIf you
+  want to test your changes locally, you can run `bundle exec bin/sambot`.\n\n###
+  Running Tests\n\nRun `bundle exec rspec spec` to execute the unit tests.\n\nRun
+  `cd integration_tests && bundle exec rspec .` to execute the integration\ntests.
+  These require that you have Docker Compose available. \n\n### Linting\n\nThere is
+  nothing here yet\n"
 email:
 - olivier.kouame@gmail.com
 executables:
@@ -384,7 +363,6 @@ files:
 - README.md
 - bin/sambot
 - bin/setup
-- bin/slackbot
 - integration_tests/docker-compose.yml
 - integration_tests/spec_helper.rb
 - integration_tests/vault_helper_spec.rb

data/bin/slackbot

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'hashie'
-require 'logger'
-$VERBOSE = nil
-Hashie.logger = Logger.new(nil)
-ENV["SLACK_API_TOKEN"] = 'xoxb-204733805091-ZiZsfVnkiwJQSVyZy3mjaDvT'
-
-require_relative '../lib/sambot'
-Sambot::Slack::GusBot.run