is2-aws-ssm-env 0.1.1

data/lib/aws-ssm-env/fetcher.rb

@@ -0,0 +1,120 @@
+require 'aws-sdk-ssm'
+
+module AwsSsmEnv
+  # AWSのParameter Storeからパラメータを取得するための基底抽象クラス。Iteratorパターンを実装。
+  # このクラスのサブクラスは`fetch`メソッドを実装する必要がある。
+  # 実装クラスを AwsSsmEnv#load の引数に渡すことによりパラメータの取得方法を切り替えられるようにする。
+  #
+  # @abstract
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class Fetcher
+    # ここの引数は AwsSsmEnv#load の呼び出し時に渡された引数がそのまま渡される。
+    # 実装クラスによって`args`の内容は変化するが、decryption, client, ssm_client_args は全サブクラス共通。
+    #
+    # @param [Hash] args AwsSsmEnv#load の呼び出し時に渡された引数。
+    # @option args [Boolean] :decryption
+    #   <optional> SecureStringパラメータを復号化するかどうか。デフォルトはtrue(復号化する)。
+    # @option args [Aws::SSM::Client] :client
+    #   <optional> Aws::SSM::Clientのインスタンス。
+    #   指定されなかった場合は`ssm_client_args`を引数にして Aws::SSM::Client#new される。
+    # @option args [Hash] :ssm_client_args
+    #   Aws::SSM::Client#new を実行するときの引数。
+    #
+    # @see http://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html
+    def initialize(**args)
+      @client = create_ssm_client(args)
+      @with_decryption = with_decryption?(args)
+    end
+
+    # Iteratorパターンを実装したメソッド。AwsSsmEnv#load から呼び出される。
+    # 実際のパラメータ取得はサブクラスで実装された fetch メソッドで行う。
+    # @yield [consumer] 取得したパラメータを受け取って処理を行うブロック引数。
+    # @yieldparam [Aws::SSM::Types::Parameter] parameter パラメータ
+    def each
+      next_token = nil
+      loop do
+        response = fetch(next_token)
+        next_token = response.next_token
+        if response.parameters.empty?
+          break
+        end
+        response.parameters.each do |p|
+          yield(p)
+        end
+        if next_token.nil?
+          break
+        end
+      end
+    end
+
+    protected
+
+    # Parameter Storeの値を取得するメソッド。サブクラスでOverrideする。
+    # 戻り値は AwsSsmEnv::FetchResult と同等の構造でなければいけない。
+    #
+    # @abstract
+    # @param [String] _next_token
+    #   NextTokenが必要な場合に渡される。
+    #   利用するAPIによっては１回で取得可能なものもあるので(GetParameters)、
+    #   このパラメータを利用するかどうかはサブクラスの実装に任せる。
+    # @return [AwsSsmEnv::FetchResult] パラメータの配列とNextToken
+    def fetch(_next_token)
+      raise NotImplementedError, 'fetch'
+    end
+
+    # @return [Boolean] SecureStringを復号化するかどうかのフラグ。
+    # サブクラスからのみアクセスを許可するため`attr_reader`は使わない。
+    def with_decryption
+      @with_decryption
+    end
+
+    # @return [Aws::SSM::Client] aws-sdkのSSMクライアントインスタンス。
+    # サブクラスからのみアクセスを許可するため`attr_reader`は使わない。
+    def client
+      @client
+    end
+
+    private
+
+    def with_decryption?(decryption: 'true', **)
+      if decryption.nil?
+        true
+      elsif decryption.to_s.downcase == 'true'
+        true
+      else
+        false
+      end
+    end
+
+    def create_ssm_client(client: nil, ssm_client_args: {}, **)
+      if client.is_a?(Aws::SSM::Client)
+        client
+      else
+        Aws::SSM::Client.new(ssm_client_args)
+      end
+    end
+  end
+
+  # parametersとnext_tokenを持った値オブジェクト。
+  # Fetcerサブクラスのfetchメソッド戻り値として利用する。
+  #
+  # @attr_reader [Array] parameters
+  #   name, value プロパティを持ったパラメータオブジェクトの配列。配列要素の実装クラスは実行されるAPIによって変わる。
+  # @attr_reader [String] next_token
+  #   １回ですべてのパラメータが取得できないAPIを利用する場合に次の値を取得するためのトークン文字列。
+  #   だいたいのAWSのAPIには用意されているため、戻り値の型であるこのクラスに持たせる。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class FetchResult
+    attr_reader :parameters, :next_token
+
+    def initialize(parameters, next_token = nil)
+      @parameters = parameters
+      @next_token = next_token
+    end
+
+    EMPTY = new([])
+  end
+end

data/lib/aws-ssm-env/fetchers/begins_with.rb

@@ -0,0 +1,84 @@
+require 'aws-ssm-env/fetcher'
+
+module AwsSsmEnv
+  # パラメータ名の前方一致で取得するFetcherクラスの実装サブクラス。
+  # `begins_with`で指定した文字列で始まるパラメータ名に一致するパラメータを取得する。
+  # [`ssm:DescribeParameters`, `ssm:GetParameters`]の認可が必要。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class BeginsWithFetcher < Fetcher
+    MAX_FETCH_SIZE = 50
+    BASE_FILTER = { key: 'Name', option: 'BeginsWith' }.freeze
+
+    # @param [Hash] args AwsSsmEnv#load の呼び出し時に渡された引数。
+    # @option args [String] :begins_with <required> パラメータ名の開始文字列。この文字列が前方一致するパラメータを取得する。
+    # @option args [Integet] :fetch_size <optional> 一度のAPI実行で取得するパラメータ数。最大50。デフォルトは50。
+    def initialize(**args)
+      super
+      @base_params = base_params(args)
+    end
+
+    protected
+
+    # @see AwsSsmEnv::Fetcher#fetch
+    #
+    # パラメータ名による検索はGetParametersByPathのような便利なAPIはないため、DescribeParametersでパラメータ名による
+    # 前方一致検索をしてからGetParametersでパラメータの値を取得している。
+    # @see http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html
+    # @see http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParameters.html
+    def fetch(next_token)
+      params = fetch_params(next_token)
+      response = client.describe_parameters(params)
+      if response.parameters.empty?
+        AwsSsmEnv::FetchResult::EMPTY
+      else
+        parameters = get_parameters(response.parameters)
+        AwsSsmEnv::FetchResult.new(parameters, response.next_token)
+      end
+    end
+
+    private
+
+    def base_params(begins_with: nil, fetch_size: '50', **)
+      if begins_with.nil?
+        raise ArgumentError, ':begins_with is required.'
+      end
+      {
+        parameter_filters: to_parameter_filters(begins_with),
+        max_results: detect_max_results(fetch_size)
+      }.freeze
+    end
+
+    def detect_max_results(fetch_size)
+      if fetch_size.nil?
+        MAX_FETCH_SIZE
+      elsif fetch_size.to_i > MAX_FETCH_SIZE
+        MAX_FETCH_SIZE
+      else
+        fetch_size.to_i
+      end
+    end
+
+    def to_parameter_filters(begins_with)
+      values = Array(begins_with)
+      [ BASE_FILTER.merge(values: values) ]
+    end
+
+    def fetch_params(next_token)
+      if next_token.nil?
+        @base_params
+      else
+        @base_params.merge(next_token: next_token)
+      end
+    end
+
+    def get_parameters(parameters)
+      response = client.get_parameters(
+        names: parameters.map(&:name),
+        with_decryption: with_decryption
+      )
+      response.parameters
+    end
+  end
+end

data/lib/aws-ssm-env/fetchers/factory.rb

@@ -0,0 +1,67 @@
+require 'aws-ssm-env/fetcher'
+
+module AwsSsmEnv
+  # Parameter Storeからパラメータを取得するためのクラスを取得もしくは生成するファクトリクラス。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class FetcherFactory
+    PATH_FETCHER = :path
+    BEGINS_WITH_FETCHER = :begins_with
+
+    class << self
+      # Parameter Storeからパラメータを取得するためのクラスを取得もしくは生成する。
+      #
+      # @param [Hash] args AwsSsmEnv#load に渡された引数がそのまま渡される。
+      # @option args [Symbol, AwsSsmEnv::Fetcher, Object] fetch
+      #   引数の詳細は AwsSsmEnv#load の説明を参照。
+      def create_fetcher(**args)
+        fetch_type = args[:fetch]
+        case fetch_type
+        when nil
+          default_fetcher(args)
+        when PATH_FETCHER
+          create_path_fetcher(args)
+        when BEGINS_WITH_FETCHER
+          create_begins_with_fetcher(args)
+        else
+          unless fetcher_instance?(fetch_type)
+            raise ArgumentError, 'Possible values for :fetch are either :path, :begins_with, ' \
+                + '"AwsSsmEnv::Fetcher" implementation class, an object with "each" method.'
+          end
+          fetch_type
+        end
+      end
+
+      private
+
+      def default_fetcher(**args)
+        if args.key?(:begins_with)
+          create_begins_with_fetcher(args)
+        else
+          create_path_fetcher(args)
+        end
+      end
+
+      def create_path_fetcher(**args)
+        require 'aws-ssm-env/fetchers/path'
+        AwsSsmEnv::PathFetcher.new(args)
+      end
+
+      def create_begins_with_fetcher(**args)
+        require 'aws-ssm-env/fetchers/begins_with'
+        AwsSsmEnv::BeginsWithFetcher.new(args)
+      end
+
+      def fetcher_instance?(object)
+        if object.is_a?(AwsSsmEnv::Fetcher)
+          true
+        elsif object.respond_to?(:each)
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aws-ssm-env/fetchers/path.rb

@@ -0,0 +1,75 @@
+require 'aws-ssm-env/fetcher'
+
+module AwsSsmEnv
+  # Parameter Storeのパス階層を利用したFetcherクラスの実装サブクラス。
+  # `path`と`recursive`を指定してパス階層のパラメータ値をまとめて取得する。
+  # `ssm:GetParametersByPath`の認可が必要。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class PathFetcher < Fetcher
+    MAX_FETCH_SIZE = 10
+
+    # @see AwsSsmEnv::Fetcher#initialize
+    #
+    # @param [Hash] args AwsSsmEnv#load の呼び出し時に渡された引数。
+    # @option args [String] :path <required> 取得するパラメータのパス。
+    # @option args [Boolean] :recursive <optional> サブパスのパラメータまで取得するかどうか。デフォルトはfalse(pathの階層のみ)。
+    # @option args [Integer] :fetch_size <optional> 一度のAPI実行で取得するパラメータ数。最大10。デフォルトは10。
+    def initialize(**args)
+      super
+      @base_params = base_params(args)
+    end
+
+    protected
+
+    # @see AwsSsmEnv::Fetcher#fetch
+    #
+    # 指定したパス階層配下のパラメータを取得する。
+    # @see http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParametersByPath.html
+    def fetch(next_token)
+      params = fetch_params(next_token)
+      client.get_parameters_by_path(params)
+    end
+
+    private
+
+    def base_params(path: nil, recursive: 'false', fetch_size: 10, **)
+      if path.nil?
+        raise ArgumentError, 'path is required.'
+      end
+      {
+        path: path,
+        recursive: recursive?(recursive),
+        with_decryption: with_decryption,
+        max_results: detect_max_results(fetch_size)
+      }.freeze
+    end
+
+    def recursive?(recursive)
+      if recursive.to_s.downcase == 'true'
+        true
+      else
+        false
+      end
+    end
+
+    def detect_max_results(fetch_size)
+      if fetch_size.nil?
+        MAX_FETCH_SIZE
+      elsif fetch_size.to_i > 10
+        MAX_FETCH_SIZE
+      else
+        fetch_size.to_i
+      end
+    end
+
+    def fetch_params(next_token)
+      if next_token.nil?
+        @base_params
+      else
+        @base_params.merge(next_token: next_token)
+      end
+    end
+  end
+end

data/lib/aws-ssm-env/loader.rb

@@ -0,0 +1,67 @@
+require 'aws-ssm-env/fetchers/factory'
+require 'aws-ssm-env/naming_strategies/factory'
+
+module AwsSsmEnv
+  # このgemのエントリポイントとなるクラス。メイン処理を行う。
+  # AWS EC2 Parameters Storeからパラメータを取得してENVに書き込む。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class Loader
+    # メイン処理。引数の詳細は AwsSsmEnv#load を参照。
+    def self.load(**args)
+      new(args).load
+    end
+
+    def initialize(**args)
+      parse_options(args)
+      if @logger
+        @logger.debug("#{self.class.name} overwrite: #{@overwrite}")
+        @logger.debug("#{self.class.name} fetcher: #{@fetcher}")
+        @logger.debug("#{self.class.name} naming_strategy: #{@naming_strategy}")
+      end
+    end
+
+    def load
+      @fetcher.each do |parameter|
+        var_name = @naming_strategy.parse_name(parameter)
+        @logger.debug("#{self.class.name} #{parameter.name} parameter value into ENV['#{var_name}']") if @logger
+        send(@applier, var_name, parameter.value)
+      end
+    end
+
+    private
+
+    def parse_options(**options)
+      @logger = options[:logger]
+      @fetcher = AwsSsmEnv::FetcherFactory.create_fetcher(options)
+      @naming_strategy = AwsSsmEnv::NamingStrategyFactory.create_naming_strategy(options)
+      @overwrite = overwrite?(options)
+      if @overwrite
+        @applier = :apply!
+      else
+        @applier = :apply
+      end
+    end
+
+    # overwriteフラグが指定されているかどうかを返す。
+    def overwrite?(overwrite: nil, **)
+      if overwrite.nil?
+        false
+      else
+        overwrite.to_s.downcase == 'true'
+      end
+    end
+
+    def apply(name, value)
+      if ENV[name]
+        return
+      end
+      apply!(name, value)
+    end
+
+    def apply!(name, value)
+      ENV[name] = value
+    end
+  end
+end

data/lib/aws-ssm-env/naming_strategies/basename.rb

@@ -0,0 +1,19 @@
+require 'aws-ssm-env/naming_strategy'
+
+module AwsSsmEnv
+  # 環境変数名にパラメータ名の階層表現のbasenameを利用するようにするNamingStrategy実装クラス。
+  # AwsSsmEnv#load で`naming`を指定しなかった場合にはこのクラスのインスタンスが利用される。
+  # 例えば、`/path/to/ENV_NAME`というパラメータ名であればENV['ENV_NAME']にパラメータ値がインジェクションされる。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class BasenameNamingStrategy < NamingStrategy
+    # @see AwsSsmEnv::NamingStrategy#parse_name
+    #
+    # パラメータ名の最後の階層を変数名として返す。
+    # @return [String] 環境変数名
+    def parse_name(parameter)
+      File.basename(parameter.name)
+    end
+  end
+end

data/lib/aws-ssm-env/naming_strategies/factory.rb

@@ -0,0 +1,68 @@
+require 'aws-ssm-env/naming_strategy'
+
+module AwsSsmEnv
+  # 環境変数名を導出するためのNamingStrategyクラスを取得もしくは生成するファクトリクラス。
+  #
+  # @author Ryohei Sonoda
+  # @since 0.1.0
+  class NamingStrategyFactory
+    BASENAME_STRATEGY = :basename
+    SNAKE_CASE_STRATEGY = :snakecase
+
+    class << self
+      # 環境変数名を導出するためのNamingStrategyクラスを取得もしくは生成する。
+      #
+      # @param [Hash] args AwsSsmEnv#load に渡された引数がそのまま渡される。
+      # @option args [Symbol, AwsSsmEnv::NamingStrategy, Object] naming
+      #   引数の詳細は AwsSsmEnv#load の説明を参照。
+      def create_naming_strategy(**args)
+        naming_strategy = args[:naming]
+        if naming_strategy.nil?
+          return default_strategy(args)
+        end
+        case naming_strategy
+        when BASENAME_STRATEGY
+          create_basename_strategy(args)
+        when SNAKE_CASE_STRATEGY
+          create_snakecase_strategy(args)
+        else
+          unknown_naming_strategy(naming_strategy)
+        end
+      end
+
+      private
+
+      def default_strategy(**args)
+        create_basename_strategy(args)
+      end
+
+      def create_basename_strategy(**args)
+        require 'aws-ssm-env/naming_strategies/basename'
+        AwsSsmEnv::BasenameNamingStrategy.new(args)
+      end
+
+      def create_snakecase_strategy(**args)
+        require 'aws-ssm-env/naming_strategies/snakecase'
+        AwsSsmEnv::SnakeCaseNamingStrategy.new(args)
+      end
+
+      def unknown_naming_strategy(naming_strategy)
+        unless naming_strategy_instance?(naming_strategy)
+          raise ArgumentError, 'Possible values for :naming are either :basename, :snakecase, ' \
+                + '"AwsSsmEnv::NamingStrategy" implementation class, an object with "parse_name" method.'
+        end
+        naming_strategy
+      end
+
+      def naming_strategy_instance?(object)
+        if object.is_a?(AwsSsmEnv::NamingStrategy)
+          true
+        elsif object.respond_to?(:parse_name)
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end