is2-aws-ssm-env 0.1.1

data/spec/aws-ssm-env/loader_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe AwsSsmEnv::Loader do
+  let(:args) { { path: '/foo' } }
+
+  describe '#initialize' do
+    let(:loader) { described_class.new(args) }
+
+    it 'has fetcher and naming_strategy' do
+      expect(loader.instance_variable_get(:@fetcher)).to be_a(AwsSsmEnv::PathFetcher)
+      expect(loader.instance_variable_get(:@naming_strategy)).to be_a(AwsSsmEnv::BasenameNamingStrategy)
+    end
+
+    describe 'overwrite option' do
+      let(:applier) { loader.instance_variable_get(:@applier) }
+
+      context 'when overwrite was not set' do
+        it '@applier is not overwrite method' do
+          expect(applier).to eq(:apply)
+        end
+      end
+
+      context 'when overwrite is nil' do
+        let(:args) { { path: '/foo', overwrite: nil } }
+
+        it '@applier is not overwrite method' do
+          expect(applier).to eq(:apply)
+        end
+      end
+
+      context 'when overwrite is truthy string' do
+        let(:args) { { path: '/foo', overwrite: 'truE' } }
+
+        it '@applier is overwrite method' do
+          expect(applier).to eq(:apply!)
+        end
+      end
+
+      context 'when overwrite is not truthy string' do
+        let(:args) { { path: '/foo', overwrite: 'foo' } }
+
+        it '@applier is not overwrite method' do
+          expect(applier).to eq(:apply)
+        end
+      end
+    end
+  end
+
+  describe '#load' do
+    context 'when overwrite is false' do
+      it 'environment variables were not overwritten' do
+        ENV['foo'] = nil
+        ENV['fizz'] = 'fizz'
+
+        loader = described_class.new(args)
+        loader.instance_variable_set(:@fetcher,
+          [ Parameter.new('foo', 'bar'), Parameter.new('fizz', 'buzz') ])
+
+        loader.load
+
+        expect(ENV['foo']).to eq('bar')
+        expect(ENV['fizz']).to eq('fizz')
+      end
+    end
+
+    context 'when overwrite is true' do
+      let(:args) { { path: '/foo', overwrite: true } }
+
+      it 'environment variables were overwritten' do
+        ENV['foo'] = nil
+        ENV['fizz'] = 'fizz'
+
+        loader = described_class.new(args)
+        loader.instance_variable_set(:@fetcher,
+          [ Parameter.new('foo', 'bar'), Parameter.new('fizz', 'buzz') ])
+
+        loader.load
+
+        expect(ENV['foo']).to eq('bar')
+        expect(ENV['fizz']).to eq('buzz')
+      end
+    end
+  end
+end

data/spec/aws-ssm-env/naming_strategies/basename_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'aws-ssm-env/naming_strategies/basename'
+
+describe AwsSsmEnv::BasenameNamingStrategy do
+  describe '#parse_name' do
+    let(:naming_strategy) { described_class.new }
+
+    it 'return the last element name of the path hierarchy' do
+      expect(naming_strategy.parse_name(Parameter.new('/path/to/ENV_NAME'))).to eq('ENV_NAME')
+      expect(naming_strategy.parse_name(Parameter.new('env_name'))).to eq('env_name')
+      expect(naming_strategy.parse_name(Parameter.new('env/name'))).to eq('name')
+    end
+  end
+end

data/spec/aws-ssm-env/naming_strategies/factory_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe AwsSsmEnv::NamingStrategyFactory do
+  describe '#create_naming_strategy' do
+    let(:naming_strategy) { described_class.create_naming_strategy(args) }
+
+    context 'when naming was not set' do
+      let(:args) { { naming: nil } }
+
+      it 'return AwsSsmEnv::BasenameNamingStrategy' do
+        expect(naming_strategy).to be_a(AwsSsmEnv::BasenameNamingStrategy)
+      end
+    end
+
+    context 'when naming is :basename' do
+      let(:args) { { naming: :basename } }
+
+      it 'return AwsSsmEnv::BasenameNamingStrategy' do
+        expect(naming_strategy).to be_a(AwsSsmEnv::BasenameNamingStrategy)
+      end
+    end
+
+    context 'when naming is :snakecase' do
+      let(:args) { { naming: :snakecase } }
+
+      it 'return AwsSsmEnv::SnakeCaseNamingStrategy' do
+        expect(naming_strategy).to be_a(AwsSsmEnv::SnakeCaseNamingStrategy)
+      end
+    end
+
+    context 'when naming is AwsSsmEnv::NamingStrategy implementation instance' do
+      let(:naming_class) { Class.new(AwsSsmEnv::NamingStrategy) { def parse_name(_); end } }
+      let(:naming_instance) { naming_class.new }
+      let(:args) { { naming: naming_instance } }
+
+      it 'return it as is' do
+        expect(naming_strategy).to eq(naming_instance)
+      end
+    end
+
+    context 'when naming has parse_name method' do
+      let(:naming_class) { Class.new { def parse_name(_); end } }
+      let(:naming_instance) { naming_class.new }
+      let(:args) { { naming: naming_instance } }
+
+      it 'return it as is' do
+        expect(naming_strategy).to eq(naming_instance)
+      end
+    end
+
+    context 'in other cases' do
+      it 'raise error' do
+        expect { described_class.create_naming_strategy(naming: 'foo') }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/aws-ssm-env/naming_strategies/snakecase_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'aws-ssm-env/naming_strategies/snakecase'
+
+describe AwsSsmEnv::SnakeCaseNamingStrategy do
+  let(:strategy) { described_class.new(args) }
+  let(:name) { 'path.to.db/password' }
+  let(:env_name) { strategy.parse_name(Parameter.new(name)) }
+
+  describe '#parse_name' do
+    context 'when :removed_prefix was not set' do
+      context 'when :begins_with was not set' do
+        let(:args) { {} }
+
+        it 'return converted path hierarchy into snake case' do
+          expect(env_name).to eq('PATH.TO.DB_PASSWORD')
+        end
+      end
+
+      context 'when :begins_with was set' do
+        let(:args) { { begins_with: 'path.to.' } }
+
+        it 'return converted path hierarchy without begins_with into snake case' do
+          expect(env_name).to eq('DB_PASSWORD')
+        end
+      end
+
+      context 'when :path was set' do
+        let(:args) { { path: 'path.to.' } }
+
+        it 'return converted path hierarchy without begins_with into snake case' do
+          expect(env_name).to eq('DB_PASSWORD')
+        end
+      end
+    end
+
+    context 'when :removed_prefix was set' do
+      context 'when :begins_with was not set' do
+        let(:args) { { removed_prefix: 'path.' } }
+
+        it 'return converted path hierarchy without removed_prefix into snake case' do
+          expect(env_name).to eq('TO.DB_PASSWORD')
+        end
+      end
+
+      context 'when :begins_with was set' do
+        let(:args) { { removed_prefix: 'path.', begins_with: 'path.to.' } }
+
+        it 'return converted path hierarchy without removed_prefix into snake case' do
+          expect(env_name).to eq('TO.DB_PASSWORD')
+        end
+      end
+
+      context 'when :path was set' do
+        let(:args) { { removed_prefix: 'path.', path: 'path.to.' } }
+
+        it 'return converted path hierarchy without removed_prefix into snake case' do
+          expect(env_name).to eq('TO.DB_PASSWORD')
+        end
+      end
+    end
+
+    context 'when :delimiter was not set' do
+      let(:args) { { removed_prefix: 'path.' } }
+
+      it 'return converted path hierarchy with replace "/" to "_"' do
+        expect(env_name).to eq('TO.DB_PASSWORD')
+      end
+    end
+
+    context 'when :delimiter was set' do
+      let(:args) { { removed_prefix: 'path.', delimiter: %r{[./]} } }
+
+      it 'return converted path hierarchy with replace "/" or "." to "_"' do
+        expect(env_name).to eq('TO_DB_PASSWORD')
+      end
+    end
+  end
+end

data/spec/aws-ssm-env/naming_strategy_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AwsSsmEnv::NamingStrategy do
+  describe '#parse_name' do
+    let!(:strategy) { described_class.new }
+
+    it 'raise error' do
+      expect { strategy.parse_name(Parameter.new('foo')) }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/aws-ssm-env/parameter.rb

@@ -0,0 +1,7 @@
+class Parameter
+  attr_reader :name, :value
+  def initialize(*args)
+    @name = args[0]
+    @value = args[1]
+  end
+end

data/spec/aws-ssm-env_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+require 'logger'
+
+describe AwsSsmEnv do
+  let(:ssm_client) {
+    stub_responses = {
+      get_parameters_by_path: {
+        parameters: [
+          { name: 'foo', value: 'bar', type: 'String', version: 1 },
+          { name: 'fizz', value: 'buzz', type: 'String', version: 1 }
+        ],
+        next_token: nil
+      }
+    }
+    Aws::SSM::Client.new(stub_responses: stub_responses)
+  }
+  let(:logger) { Logger.new('/dev/null') }
+
+  describe '#load' do
+    context 'when overwrite is false' do
+      it 'environment variables were not overwritten' do
+        ENV['foo'] = nil
+        ENV['fizz'] = 'fizz'
+
+        described_class.load(client: ssm_client, path: '/path')
+
+        expect(ENV['foo']).to eq('bar')
+        expect(ENV['fizz']).to eq('fizz')
+      end
+    end
+
+    context 'when overwrite is true' do
+      it 'environment variables were overwritten' do
+        ENV['foo'] = nil
+        ENV['fizz'] = 'fizz'
+
+        described_class.load!(client: ssm_client, path: '/path', logger: logger)
+
+        expect(ENV['foo']).to eq('bar')
+        expect(ENV['fizz']).to eq('buzz')
+      end
+    end
+  end
+
+  # @example Request syntax with placeholder values
+  #
+  #   resp = client.put_parameter({
+  #     name: "PSParameterName", # required
+  #     description: "ParameterDescription",
+  #     value: "PSParameterValue", # required
+  #     type: "String", # required, accepts String, StringList, SecureString
+  #     key_id: "ParameterKeyId",
+  #     overwrite: false,
+  #     allowed_pattern: "AllowedPattern",
+  #   })
+  #
+  describe 'Integration test', integration: true do
+    PARAMETERS = [
+      { name: "/test/#{RUBY_VERSION}/aws-ssm-env/db_password", value: 'db_password', type: :SecureString },
+      { name: "/test/#{RUBY_VERSION}/aws-ssm-env/db/username", value: 'db_username', type: :String },
+      { name: "/test/#{RUBY_VERSION}/aws-ssm-env/roles", value: 'admin,guest', type: :StringList },
+      { name: "test.#{RUBY_VERSION}.aws-ssm-env.db_password", value: 'db_password', type: :SecureString },
+      { name: "test.#{RUBY_VERSION}.aws-ssm-env.username", value: 'db_username', type: :String },
+      { name: "test.#{RUBY_VERSION}.aws-ssm-env.roles", value: 'admin,guest', type: :StringList },
+    ].freeze
+    ENV_NAMES = %w[db_password username roles].freeze
+
+    def remove_env_all
+      ENV_NAMES.each do |name|
+        ENV[name] = nil
+        ENV[name.upcase] = nil
+      end
+    end
+
+    before :all do
+      @client = Aws::SSM::Client.new
+      PARAMETERS.each do |parameter|
+        @client.put_parameter(
+          name: parameter[:name],
+          value: parameter[:value],
+          type: parameter[:type].to_s,
+          overwrite: true
+        )
+      end
+    end
+
+    before do
+      remove_env_all
+    end
+
+    after :all do
+      @client.delete_parameters(names: PARAMETERS.map { |p| p[:name] })
+    end
+
+    after do
+      remove_env_all
+    end
+
+    describe 'path fetcher' do
+      context 'when recursive is true' do
+        it 'set environment variables from EC2 Parameter Store parameters' do
+          described_class.load(path: "/test/#{RUBY_VERSION}/aws-ssm-env", recursive: true, logger: logger)
+          expect(ENV['db_password']).to eq('db_password')
+          expect(ENV['username']).to eq('db_username')
+          expect(ENV['roles']).to eq('admin,guest')
+        end
+      end
+
+      context 'when recursive is false' do
+        it 'set environment variables from EC2 Parameter Store parameters' do
+          described_class.load(path: "/test/#{RUBY_VERSION}/aws-ssm-env", recursive: false, logger: logger)
+          expect(ENV['db_password']).to eq('db_password')
+          expect(ENV['username']).to be_nil
+          expect(ENV['roles']).to eq('admin,guest')
+        end
+      end
+    end
+
+    describe 'begins_with fetcher' do
+      it 'set environment variables from EC2 Parameter Store parameters' do
+        described_class.load(begins_with: "test.#{RUBY_VERSION}.aws-ssm-env.", naming: :snakecase, delimiter: '.', logger: logger)
+        expect(ENV['DB_PASSWORD']).to eq('db_password')
+        expect(ENV['USERNAME']).to eq('db_username')
+        expect(ENV['ROLES']).to eq('admin,guest')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+else
+  require 'simplecov'
+  require 'simplecov-console'
+  SimpleCov.start do
+    add_filter '/vendor/'
+    add_filter '/spec/'
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console,
+    ]
+  end
+end
+
+require 'aws-ssm-env'
+require 'aws-ssm-env/parameter'
+
+RSpec.configure do |config|
+  config.filter_run_excluding(integration: true) unless ENV['CI']
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: is2-aws-ssm-env
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ryohei Sonoda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set parameters acquired from AWS EC2 Parameter Store as environment variables.
+email:
+- ryohei-sonoda@m3.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- README_ja.md
+- lib/aws-ssm-env.rb
+- lib/aws-ssm-env/fetcher.rb
+- lib/aws-ssm-env/fetchers/begins_with.rb
+- lib/aws-ssm-env/fetchers/factory.rb
+- lib/aws-ssm-env/fetchers/path.rb
+- lib/aws-ssm-env/loader.rb
+- lib/aws-ssm-env/naming_strategies/basename.rb
+- lib/aws-ssm-env/naming_strategies/factory.rb
+- lib/aws-ssm-env/naming_strategies/snakecase.rb
+- lib/aws-ssm-env/naming_strategy.rb
+- lib/aws-ssm-env/version.rb
+- spec/aws-ssm-env/fetcher_spec.rb
+- spec/aws-ssm-env/fetchers/begins_with_spec.rb
+- spec/aws-ssm-env/fetchers/factory_spec.rb
+- spec/aws-ssm-env/fetchers/path_spec.rb
+- spec/aws-ssm-env/loader_spec.rb
+- spec/aws-ssm-env/naming_strategies/basename_spec.rb
+- spec/aws-ssm-env/naming_strategies/factory_spec.rb
+- spec/aws-ssm-env/naming_strategies/snakecase_spec.rb
+- spec/aws-ssm-env/naming_strategy_spec.rb
+- spec/aws-ssm-env/parameter.rb
+- spec/aws-ssm-env_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonodar/aws-ssm-env-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/sonodar/aws-ssm-env-ruby
+  changelog_uri: https://github.com/sonodar/aws-ssm-env-ruby/tree/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Set parameters acquired from AWS EC2 Parameter Store as environment variables.
+test_files:
+- spec/aws-ssm-env/fetcher_spec.rb
+- spec/aws-ssm-env/fetchers/begins_with_spec.rb
+- spec/aws-ssm-env/fetchers/factory_spec.rb
+- spec/aws-ssm-env/fetchers/path_spec.rb
+- spec/aws-ssm-env/loader_spec.rb
+- spec/aws-ssm-env/naming_strategies/basename_spec.rb
+- spec/aws-ssm-env/naming_strategies/factory_spec.rb
+- spec/aws-ssm-env/naming_strategies/snakecase_spec.rb
+- spec/aws-ssm-env/naming_strategy_spec.rb
+- spec/aws-ssm-env/parameter.rb
+- spec/aws-ssm-env_spec.rb
+- spec/spec_helper.rb