aws_session_token 0.3.0

data/spec/aws_session_token/options_spec.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+#
+# AWS Session Token Gem - Tool to wrap AWS API to create and store Session tokens
+# so that other commands/tools (e.g. Terraform) can function as necessary
+#
+#
+# Copyright 2018 Bryan Stopp <bryan.stopp@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe AwsSessionToken::Options, :isolated_environment do
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+
+  subject(:options) { described_class.new }
+
+  let(:demo_creds) do
+    Aws::SharedCredentials.new
+  end
+
+  describe 'initialize' do
+    it 'should default credentials_file' do
+      expect(options.credentials_file).to eq(demo_creds.path)
+    end
+    it 'should default the profile name' do
+      expect(options.profile).to eq(demo_creds.profile_name)
+    end
+    it 'should default the session_profile name' do
+      expect(options.session_profile).to eq('session_profile')
+    end
+    it 'should default the duration' do
+      expect(options.duration).to eq(AwsSessionToken::Options::DURATION)
+    end
+  end
+
+  describe 'options' do
+    describe '-h/--help' do
+      it 'exits cleanly' do
+        expect { options.parse ['-h'] }.to exit_with_code(0)
+        expect { options.parse ['--help'] }.to exit_with_code(0)
+      end
+
+      it 'shows help text' do
+        begin
+          options.parse(['--help'])
+        rescue SystemExit # rubocop:disable Lint/HandleExceptions
+        end
+
+        expected = <<~HELP
+          Usage: aws_session_token [options]
+
+              -f, --file FILE                  Specify a custom credentials file.
+              -u, --user USER                  Specify the AWS User name for passing to API.
+              -p, --profile PROFILE            Specify the AWS credentials profile to use. Also sets user, if user is not provided.
+              -s, --session SESSION_PROFILE    Specify the name of the profile used to store the session credentials.
+              -d, --duration DURATION          Specify the duration the of the token in seconds. (Default 3600)
+              -t, --token TOKEN                Specify the OTP Token to use for creating the session credentials.
+
+          Common options:
+              -h, --help                       Show this message.
+              -v, --version                    Show version.
+        HELP
+        expect($stdout.string).to eq(expected)
+      end
+    end
+
+    describe '-v/--version' do
+      it 'exits cleanly' do
+        expect { options.parse(['-h']) }.to exit_with_code(0)
+        expect { options.parse(['--help']) }.to exit_with_code(0)
+      end
+      it 'shows version' do
+        begin
+          options.parse(['--version'])
+        rescue SystemExit # rubocop:disable Lint/HandleExceptions
+        end
+        expected = SemVer.find.format(+ '%M.%m.%p%s')
+        expect($stdout.string.chomp).to eq(expected)
+      end
+    end
+
+    describe '-f/--file' do
+      it 'fails if no argument' do
+        expect { options.parse(['-f']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--file']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'succeeds with an argument' do
+        expect { options.parse(%w[-f /foo/bar]) }.to_not raise_error(OptionParser::MissingArgument)
+        expect { options.parse(%w[--file /foo/bar]) }.to_not raise_error(OptionParser::MissingArgument)
+      end
+    end
+
+    describe '-p/--profile' do
+      it 'fails if no argument' do
+        expect { options.parse(['-p']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--profile']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'succeeds with an argument' do
+        expect { options.parse(%w[-p foo]) }.to_not raise_error(OptionParser::MissingArgument)
+        expect { options.parse(%w[--profile foo]) }.to_not raise_error(OptionParser::MissingArgument)
+      end
+    end
+
+    describe '-u/--user' do
+      it 'fails if no argument' do
+        expect { options.parse(['-u']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--user']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'succeeds with an argument' do
+        expect { options.parse(%w[-u foo]) }.to_not raise_error(OptionParser::MissingArgument)
+        expect { options.parse(%w[--user foo]) }.to_not raise_error(OptionParser::MissingArgument)
+      end
+    end
+
+    describe '-s/--session' do
+      it 'fails if no argument' do
+        expect { options.parse(['-s']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--session']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'succeeds with an argument' do
+        expect { options.parse(%w[-s bar]) }.to_not raise_error(OptionParser::MissingArgument)
+        expect { options.parse(%w[--session bar]) }.to_not raise_error(OptionParser::MissingArgument)
+      end
+    end
+
+    describe '-d/--duration' do
+      it 'fails if no argument' do
+        expect { options.parse(['-d']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--duration']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'fails if argument is not an integer' do
+        expect { options.parse(%w[-d abc]) }.to raise_error(OptionParser::InvalidArgument)
+        expect { options.parse(%w[--duration abc]) }.to raise_error(OptionParser::InvalidArgument)
+      end
+      it 'succeeds if argument is an integer' do
+        expect { options.parse(%w[-d 1800]) }.to_not raise_error
+        expect { options.parse(%w[--duration 1800]) }.to_not raise_error
+      end
+    end
+
+    describe '-t/--token' do
+      it 'succeeds with optional argument' do
+        expect { options.parse(['-t']) }.to raise_error(OptionParser::MissingArgument)
+        expect { options.parse(['--token']) }.to raise_error(OptionParser::MissingArgument)
+      end
+      it 'succeeds with an argument' do
+        expect { options.parse(%w[-t 123456]) }.to_not raise_error
+        expect { options.parse(%w[--token 123456]) }.to_not raise_error
+      end
+    end
+
+    describe 'validate' do
+      it 'does not allow -p & -s' do
+        expect { options.parse(%w[-p default -s default]) }.to raise_error(ArgumentError)
+      end
+      it 'defaults profile attr to user if unspecified' do
+        options.parse(%w[-p foo])
+        expect(options.profile).to eq(options.user)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--format
+s
+--colour
+--loadby
+mtime
+--backtrace
+--rdebugger

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+#
+# AWS Session Token Gem - Tool to wrap AWS API to create and store Session tokens
+# so that other commands/tools (e.g. Terraform) can function as necessary.
+#
+# Copyright 2018 Bryan Stopp <bryan.stopp@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'simplecov'
+
+module SimpleCov
+  module Configuration
+    def clean_filters
+      @filters = []
+    end
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+  load_profile 'bundler_filter'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'aws_session_token'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+end

data/spec/support/custom_matchers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#
+# AWS Session Token Gem - Tool to wrap AWS API to create and store
+# Session tokens so that other commands/tools (e.g. Terraform) can function as
+# necessary.
+#
+#
+# Copyright 2018 Bryan Stopp <bryan.stopp@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+RSpec::Matchers.define :exit_with_code do |code|
+  supports_block_expectations
+
+  actual = nil
+
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual && actual == code
+  end
+
+  failure_message do
+    "expected block to call exit(#{code}) but exit" +
+      (actual.nil? ? ' not called' : "(#{actual}) was called")
+  end
+
+  failure_message_when_negated do
+    "expected block not to call exit(#{code})"
+  end
+
+  description do
+    "expect block to call exit(#{code})"
+  end
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: aws_session_token
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Bryan Stopp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: copyright-header
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 'Tool to wrap AWS API to create and store Session tokens so that other
+  commands/tools (e.g. Terraform) can function as necessary.
+
+'
+email: bryan.stopp@gmail.com
+executables:
+- aws_session_token
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- ".document"
+- ".rspec"
+- ".rubocop.yml"
+- ".semver"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/aws_session_token
+- config/syntax.yaml
+- lib/aws_session_token.rb
+- lib/aws_session_token/cli.rb
+- lib/aws_session_token/credentials_file.rb
+- lib/aws_session_token/options.rb
+- spec/aws_session_token/cli_spec.rb
+- spec/aws_session_token/credentials_file_spec.rb
+- spec/aws_session_token/options_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/custom_matchers.rb
+homepage: http://github.com/bstopp/aws_session_token
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Create & Store AWS Session Tokens
+test_files: []