3scale_toolbox 0.17.1 → 0.19.0

data/lib/3scale_toolbox/crds.rb

@@ -0,0 +1,16 @@
+require '3scale_toolbox/crds/application_plan_dump'
+require '3scale_toolbox/crds/backend_method_dump'
+require '3scale_toolbox/crds/backend_mapping_rule_dump'
+require '3scale_toolbox/crds/backend_metric_dump'
+require '3scale_toolbox/crds/backend_dump'
+require '3scale_toolbox/crds/backend_usage_dump'
+require '3scale_toolbox/crds/limit_dump'
+require '3scale_toolbox/crds/mapping_rule_dump'
+require '3scale_toolbox/crds/method_dump'
+require '3scale_toolbox/crds/metric_dump'
+require '3scale_toolbox/crds/pricing_rule_dump'
+require '3scale_toolbox/crds/product_dump'
+require '3scale_toolbox/crds/product_deployment_parser'
+require '3scale_toolbox/crds/backend_parser'
+require '3scale_toolbox/crds/product_parser'
+require '3scale_toolbox/crds/remote'

data/lib/3scale_toolbox/crds/application_plan_dump.rb

@@ -0,0 +1,19 @@
+module ThreeScaleToolbox
+  module CRD
+    module ApplicationPlanSerializer
+      def to_cr
+        {
+          'name' => name,
+          'appsRequireApproval' => approval_required?,
+          'trialPeriod' => trial_period_days,
+          'setupFee' => setup_fee,
+          'custom' => custom,
+          'state' => state,
+          'costMonth' => cost_per_month,
+          'pricingRules' => pricing_rules.map(&:to_cr),
+          'limits' => limits.map(&:to_cr)
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_dump.rb

@@ -0,0 +1,39 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendSerializer
+      def to_cr
+        {
+          'apiVersion' => 'capabilities.3scale.net/v1beta1',
+          'kind' => 'Backend',
+          'metadata' => {
+            'annotations' => {
+              '3scale_toolbox_created_at' => Time.now.utc.iso8601,
+              '3scale_toolbox_version' => ThreeScaleToolbox::VERSION
+            },
+            'name' => cr_name
+          },
+          'spec' => {
+            'name' => name,
+            'systemName' => system_name,
+            'privateBaseURL' => private_endpoint,
+            'description' => description,
+            'mappingRules' => mapping_rules.map(&:to_cr),
+            'metrics' => metrics.each_with_object({}) do |metric, hash|
+              hash[metric.system_name] = metric.to_cr
+            end,
+            'methods' => methods.each_with_object({}) do |method, hash|
+              hash[method.system_name] = method.to_cr
+            end
+          }
+        }
+      end
+
+      def cr_name
+        # Should be DNS1123 subdomain name
+        # TODO run validation for DNS1123
+        # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/
+        "#{system_name.gsub(/[^[a-zA-Z0-9\-\.]]/, '.')}.#{Helper.random_lowercase_name}"
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_mapping_rule_dump.rb

@@ -0,0 +1,26 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMappingRuleSerializer
+      def to_cr
+        {
+          'httpMethod' => http_method,
+          'pattern' => pattern,
+          'metricMethodRef' => metric_method_ref,
+          'increment' => delta,
+          'last' => last,
+        }
+      end
+
+      def metric_method_ref
+        if (method = backend.methods.find { |m| m.id == metric_id })
+          method.system_name
+        elsif (metric = backend.metrics.find { |m| m.id == metric_id })
+          metric.system_name
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Backend #{backend.system_name} " \
+            "mapping rule #{id} referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_method_dump.rb

@@ -0,0 +1,12 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMethodSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_metric_dump.rb

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMetricSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'unit' => unit,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_parser.rb

@@ -0,0 +1,55 @@
+module ThreeScaleToolbox
+  module CRD
+    class BackendParser
+      Metric = Struct.new(:system_name, :friendly_name, :description, :unit)
+      Method = Struct.new(:system_name, :friendly_name, :description)
+      MappingRule = Struct.new(:metric_ref, :http_method, :pattern, :delta, :last)
+
+      attr_reader :cr
+
+      def initialize(cr)
+        @cr = cr
+      end
+
+      def system_name
+        cr.dig('spec', 'systemName')
+      end
+
+      def name
+        cr.dig('spec', 'name')
+      end
+
+      def description
+        cr.dig('spec', 'description')
+      end
+
+      def private_endpoint
+        cr.dig('spec', 'privateBaseURL')
+      end
+
+      def metrics
+        @metrics ||= (cr.dig('spec', 'metrics') || {}).map do |system_name, metric|
+          Metric.new(system_name, metric['friendlyName'], metric['description'], metric['unit'])
+        end
+      end
+
+      def methods
+        @methods ||= (cr.dig('spec', 'methods') || {}).map do |system_name, method|
+          Method.new(system_name, method['friendlyName'], method['description'])
+        end
+      end
+
+      def mapping_rules
+        @mapping_rules ||= (cr.dig('spec', 'mappingRules') || []).map do |mapping_rule|
+          MappingRule.new(mapping_rule['metricMethodRef'], mapping_rule['httpMethod'],
+            mapping_rule['pattern'], mapping_rule['increment'], mapping_rule['last'])
+        end
+      end
+
+      # Metrics and methods index by system_name
+      def metrics_index
+        @metrics_index ||= (methods + metrics).each_with_object({}) { |metric, h| h[metric.system_name] = metric }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_usage_dump.rb

@@ -0,0 +1,11 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendUsageSerializer
+      def to_cr
+        {
+          'path' => path
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/limit_dump.rb

@@ -0,0 +1,37 @@
+module ThreeScaleToolbox
+  module CRD
+    module Limit
+      def to_cr
+        {
+          'period' => period,
+          'value' => value,
+          'metricMethodRef' => metric_system_name,
+        }
+      end
+
+      def metric_system_name
+        # Find in service methods
+        # Find in service metrics
+        # Find in backend methods
+        # Find in backend metrics
+        if (method = plan.service.methods.find { |m| m.id == metric_id })
+          { 'systemName' => method.system_name }
+        elsif (metric = plan.service.metrics.find { |m| m.id == metric_id })
+          { 'systemName' => metric.system_name }
+        elsif (backend = backend_from_metric)
+          if (backend_metric = backend.metrics.find { |m| m.id == metric_id })
+            { 'systemName' => backend_metric.system_name, 'backend' => backend.system_name }
+          elsif (backend_method = backend.methods.find { |m| m.id == metric_id })
+            { 'systemName' => backend_method.system_name, 'backend' => backend.system_name }
+          else
+            raise ThreeScaleToolbox::Error, "Unexpected error. Limit #{id} " \
+              "referencing to metric id #{metric_id} which has not been found"
+          end
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Limit #{id} " \
+            "referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/mapping_rule_dump.rb

@@ -0,0 +1,26 @@
+module ThreeScaleToolbox
+  module CRD
+    module MappingRuleSerializer
+      def to_cr
+        {
+          'httpMethod' => http_method,
+          'pattern' => pattern,
+          'metricMethodRef' => metric_method_ref,
+          'increment' => delta,
+          'last' => last,
+        }
+      end
+
+      def metric_method_ref
+        if (method = service.methods.find { |m| m.id == metric_id })
+          method.system_name
+        elsif (metric = service.metrics.find { |m| m.id == metric_id })
+          metric.system_name
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Service #{service.system_name} " \
+            "mapping rule #{id} referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/method_dump.rb

@@ -0,0 +1,12 @@
+module ThreeScaleToolbox
+  module CRD
+    module MethodSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/metric_dump.rb

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module CRD
+    module MetricSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'unit' => unit,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/pricing_rule_dump.rb

@@ -0,0 +1,38 @@
+module ThreeScaleToolbox
+  module CRD
+    module PricingRuleSerializer
+      def to_cr
+        {
+          'from' => min,
+          'to' => max,
+          'pricePerUnit' => cost_per_unit,
+          'metricMethodRef' => metric_system_name,
+        }
+      end
+
+      def metric_system_name
+        # Find in service methods
+        # Find in service metrics
+        # Find in backend methods
+        # Find in backend metrics
+        if (method = plan.service.methods.find { |m| m.id == metric_id })
+          { 'systemName' => method.system_name }
+        elsif (metric = plan.service.metrics.find { |m| m.id == metric_id })
+          { 'systemName' => metric.system_name }
+        elsif (backend = backend_from_metric)
+          if (backend_metric = backend.metrics.find { |m| m.id == metric_id })
+            { 'systemName' => backend_metric.system_name, 'backend' => backend.system_name }
+          elsif (backend_method = backend.methods.find { |m| m.id == metric_id })
+            { 'systemName' => backend_method.system_name, 'backend' => backend.system_name }
+          else
+            raise ThreeScaleToolbox::Error, "Unexpected error. PricingRule #{id} " \
+              "referencing to metric id #{metric_id} which has not been found"
+          end
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. PricingRule #{id} " \
+            "referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/product_deployment_parser.rb

@@ -0,0 +1,329 @@
+module ThreeScaleToolbox
+  module CRD
+    # ProductDeploymentCRDParser parses CRD Format
+    # https://github.com/3scale/3scale-operator/blob/3scale-2.10.0-CR2/doc/product-reference.md#productdeploymentspec
+    class ProductDeploymentParser
+      class ApicastHostedParser
+        attr_reader :authentication_parser
+
+        def initialize(cr)
+          @authentication_parser = AuthenticationParser.new(cr.fetch('authentication', {}))
+        end
+
+        def deployment_option
+          'hosted'
+        end
+
+        def method_missing(name, *args)
+          authentication_parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class ApicastSelfManagedParser
+        attr_reader :authentication_parser, :cr
+
+        def initialize(cr)
+          @cr = cr
+          @authentication_parser = AuthenticationParser.new(cr.fetch('authentication', {}))
+        end
+
+        def deployment_option
+          'self_managed'
+        end
+
+        def endpoint
+          cr['productionPublicBaseURL']
+        end
+
+        def sandbox_endpoint
+          cr['stagingPublicBaseURL']
+        end
+
+        def method_missing(name, *args)
+          authentication_parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class AuthenticationParser
+        attr_reader :parser
+
+        def initialize(cr)
+          @parser = if cr.has_key? 'userkey'
+                      UserKeyParser.new(cr.fetch('userkey'))
+                    elsif cr.has_key? 'appKeyAppID'
+                      AppKeyParser.new(cr.fetch('appKeyAppID'))
+                    elsif cr.has_key? 'oidc'
+                      OidcParser.new(cr.fetch('oidc'))
+                    else
+                      raise ThreeScaleToolbox::Error, "Unknown authentication option: #{cr.keys}"
+                    end
+        end
+
+
+        def method_missing(name, *args)
+          parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class AppKeyParser
+
+        attr_reader :cr, :security_parser, :gaterway_response_parser
+
+        def initialize(cr)
+          @cr = cr
+          @security_parser = SecurityParser.new(cr.fetch('security', {}))
+          @gaterway_response_parser = GatewayResponseParser.new(cr.fetch('gatewayResponse', {}))
+        end
+
+        def auth_app_id
+          cr['appID']
+        end
+
+        def auth_app_key
+          cr['appKey']
+        end
+
+        def credentials_location
+          cr['credentials']
+        end
+
+        def backend_version
+          '2'
+        end
+
+        def method_missing(name, *args)
+          res = security_parser.public_send(name, *args)
+          return res unless res.nil?
+
+          gaterway_response_parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class UserKeyParser
+        attr_reader :cr, :security_parser, :gaterway_response_parser
+
+        def initialize(cr)
+          @cr = cr
+          @security_parser = SecurityParser.new(cr.fetch('security', {}))
+          @gaterway_response_parser = GatewayResponseParser.new(cr.fetch('gatewayResponse', {}))
+        end
+
+        def backend_version
+          '1'
+        end
+
+        def auth_user_key
+          cr['authUserKey']
+        end
+
+        def credentials_location
+          cr['credentials']
+        end
+
+        def method_missing(name, *args)
+          res = security_parser.public_send(name, *args)
+          return res unless res.nil?
+
+          gaterway_response_parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class OidcParser
+        attr_reader :cr, :security_parser, :gaterway_response_parser, :authentication_flow_parser
+
+        def initialize(cr)
+          @cr = cr
+          @security_parser = SecurityParser.new(cr.fetch('security', {}))
+          @gaterway_response_parser = GatewayResponseParser.new(cr.fetch('gatewayResponse', {}))
+          @authentication_flow_parser = AuthenticationFlowParser.new(cr.fetch('authenticationFlow', {}))
+        end
+
+        def backend_version
+          'oidc'
+        end
+
+        def credentials_location
+          cr['credentials']
+        end
+
+        def oidc_issuer_endpoint
+          cr['issuerEndpoint']
+        end
+
+        def oidc_issuer_type
+          cr['issuerType']
+        end
+
+        def jwt_claim_with_client_id
+          cr['jwtClaimWithClientID']
+        end
+
+        def jwt_claim_with_client_id_type
+          cr['jwtClaimWithClientIDType']
+        end
+
+        def method_missing(name, *args)
+          res = authentication_flow_parser.public_send(name, *args)
+          return res unless res.nil?
+
+          res = security_parser.public_send(name, *args)
+          return res unless res.nil?
+
+          gaterway_response_parser.public_send(name, *args)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super
+        end
+      end
+
+      class SecurityParser
+        attr_reader :cr
+
+        def initialize(cr)
+          @cr = cr
+        end
+
+        def secret_token
+          cr['secretToken']
+        end
+
+        def hostname_rewrite
+          cr['hostHeader']
+        end
+
+        def method_missing(name, *args)
+          nil
+        end
+      end
+
+      class GatewayResponseParser
+        attr_reader :cr
+
+        def initialize(cr)
+          @cr = cr
+        end
+
+        def error_auth_failed
+          cr['errorAuthFailed']
+        end
+
+        def error_auth_missing
+          cr['errorAuthMissing']
+        end
+
+        def error_status_auth_failed
+          cr['errorStatusAuthFailed']
+        end
+
+        def error_headers_auth_failed
+          cr['errorHeadersAuthFailed']
+        end
+
+        def error_status_auth_missing
+          cr['errorStatusAuthMissing']
+        end
+
+        def error_headers_auth_missing
+          cr['errorHeadersAuthMissing']
+        end
+
+        def error_no_match
+          cr['errorNoMatch']
+        end
+
+        def error_status_no_match
+          cr['errorStatusNoMatch']
+        end
+
+        def error_headers_no_match
+          cr['errorHeadersNoMatch']
+        end
+
+        def error_limits_exceeded
+          cr['errorLimitsExceeded']
+        end
+
+        def error_status_limits_exceeded
+          cr['errorStatusLimitsExceeded']
+        end
+
+        def error_headers_limits_exceeded
+          cr['errorHeadersLimitsExceeded']
+        end
+
+        def method_missing(name, *args)
+          nil
+        end
+      end
+
+      class AuthenticationFlowParser
+        attr_reader :cr
+
+        def initialize(cr)
+          @cr = cr
+        end
+
+        def standard_flow_enabled
+          cr.fetch('standardFlowEnabled', false)
+        end
+
+        def implicit_flow_enabled
+          cr.fetch('implicitFlowEnabled', false)
+        end
+
+        def service_accounts_enabled
+          cr.fetch('serviceAccountsEnabled', false)
+        end
+
+        def direct_access_grants_enabled
+          cr.fetch('directAccessGrantsEnabled', false)
+        end
+
+        def method_missing(name, *args)
+          nil
+        end
+      end
+
+      attr_reader :deployment_parser
+
+      def initialize(cr)
+        @deployment_parser = if cr.has_key? 'apicastSelfManaged'
+                               ApicastSelfManagedParser.new(cr.fetch('apicastSelfManaged'))
+                             elsif cr.has_key? 'apicastHosted'
+                               ApicastHostedParser.new(cr.fetch('apicastHosted'))
+                             else
+                               raise ThreeScaleToolbox::Error, "Unknown deployment option: #{cr.keys}"
+                             end
+      end
+
+      def method_missing(name, *args)
+        deployment_parser.public_send(name, *args)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super
+      end
+    end
+  end
+end