genome 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6cc6d10ee7b5ba25627f3d129a6743478c18df27f21909a0ca8a753dbc91a94
-  data.tar.gz: d3254e10ad2679ab940d14a5d03e1644d0fbe2b73b9bfc002e26c6ea817126ad
+  metadata.gz: 65776260dc82ffcf09195b7d88e38b9c0c6531e26689140fde6db61041718df4
+  data.tar.gz: 7474b6aed06682d8fa85191137b0cccedd91c832fab09a3a11a70d8c2d091e0c
 SHA512:
-  metadata.gz: d60d317c8ab65fa464b903ec95ad115825061dbaf341736e9cf096690962a3c30ad79037b6f7454abfcf4dd86580d5bdf75e468e9f08772be85f2c25a20d6df6
-  data.tar.gz: 5e0078157a938c7e0838a4bf4abe8c41058e2d0d79cdfcff701c4955a32b87dd94173473c314f5b5db8eee0e245eba5b72ea40925323f2cd15379e93b47531ac
+  metadata.gz: 4df7c0bb09d173c65ea59be9cd7b5f47bf6eb0a7447eec9322e69f74721421ae2d4c6ab0dca2f02806f130e0a7a3d59cc862ba4ffb2de3bc8ac2cffb44a73010
+  data.tar.gz: 54b94dd8b505d0d002fabbfa00f2677b38aa1675be332f48b4a81b8b1446afdbeb36d7eb9c1d4c5d3c961d212eb419b37cda72d9b581d0833c72577b667ebeb8

data/.gitignore

@@ -8,7 +8,7 @@
 /spec/reports/
 /tmp/
 /.idea
-
+/*.gem
 /*.env
 
 # rspec failure tracking

data/lib/genome/builder.rb

@@ -9,16 +9,22 @@ module Genome
       resources = {}
 
       resource.templates.each do |template_name, template|
-        parameters = evaluate_parameters(template[:parameters])
+        properties = evaluate_properties(template[:properties])
 
         dependencies = template[:dependencies]
 
-        resource_template = template[:klass].new(template_name, parameters, dependencies)
+        resource_template = template[:klass].new(template_name, properties, dependencies)
 
         resources.merge!(resource_template.to_h)
       end
 
-      generate_document(resources: resources, description: resource.description)
+      parameters = {}
+
+      resource.parameters.each do |_parameter_name, parameter|
+        parameters.merge!(parameter.to_h)
+      end
+
+      generate_document(resources: resources, parameters: parameters, description: resource.resource_description)
     end
 
     def self.generate_document(metadata: {}, description: nil, resources: {}, parameters: {}, outputs: {})
@@ -32,27 +38,27 @@ module Genome
       }
     end
 
-    def self.evaluate_parameters(parameters)
-      # TODO: convert classes and helper functions into appropriate parameters
-      processed_parameters = {}
+    def self.evaluate_properties(properties)
+      # TODO: convert classes and helper functions into appropriate properties
+      processed_properties = {}
 
-      parameters.each do |parameter_name, parameter_value|
-        processed_parameters[parameter_name] = evaluate_parameter_value(parameter_value)
+      properties.each do |properties_name, properties_value|
+        processed_properties[properties_name] = evaluate_properties_value(properties_value)
       end
 
-      processed_parameters
+      processed_properties
     end
 
-    def self.evaluate_parameter_value(parameter_value)
-        case parameter_value
+    def self.evaluate_properties_value(properties_value)
+        case properties_value
         when Array
-          parameter_value.map do |single_parameter_value|
-            evaluate_parameter_value(single_parameter_value)
+          properties_value.map do |single_properties_value|
+            evaluate_properties_value(single_properties_value)
           end
         when Genome::Reference
-          { Ref: parameter_value.reference_name }
+          { Ref: properties_value.reference_name }
         else
-          parameter_value
+          properties_value
         end
     end
 

data/lib/genome/error.rb

@@ -5,5 +5,13 @@ module Genome
     class DuplicateProperty < Base; end
 
     class DuplicateTemplate < Base; end
+
+    class DuplicateParameter < Base; end
+
+    class MissingParameterName < Base; end
+
+    class UnknownParameter < Base; end
+
+    class InvalidParameterType < Base; end
   end
 end

data/lib/genome/parameter.rb

@@ -0,0 +1,71 @@
+require_relative 'error'
+
+module Genome
+  class Parameter
+    PARAMETERS = {
+      AllowedPattern: { type: :string },
+      AllowedValues: { type: :array },
+      ConstraintDescription: { type: :string },
+      Default: { type: :any },
+      Description: { type: :string },
+      MaxLength: { type: :integer },
+      MaxValue: { type: :integer },
+      MinLength: { type: :integer },
+      MinValue: { type: :integer },
+      NoEcho: { type: :boolean },
+      Type: { type: :string },
+    }.freeze
+
+    attr_reader :parameter_name
+    attr_accessor :parameter_options
+
+    def initialize(parameter_name:, parameter_options: {})
+      validate_parameter_options!(parameter_options)
+
+      @parameter_name    = parameter_name
+      @parameter_options = parameter_options
+    end
+
+    def validate_parameter_options!(parameter_options)
+      parameter_options.each do |parameter_option_name, parameter_option_value|
+        parameter_option_rules = PARAMETERS[parameter_option_name]
+
+        raise Error::UnknownParameter, "Unknown parameter '#{parameter_option_name}'" unless parameter_option_rules
+
+        allowed_parameter_type = parameter_option_rules[:type]
+
+        raise Error::InvalidParameterType, "Invalid parameter type #{{
+          parameter_value: parameter_value,
+          allowed_parameter_type: allowed_parameter_type,
+        }}" unless check_parameter_type(parameter_option_value, allowed_parameter_type)
+      end
+    end
+
+    def check_parameter_type(parameter_value, allowed_parameter_type)
+      case allowed_parameter_type
+      when :string
+        parameter_value.is_a?(String)
+      when :integer
+        begin
+          Integer(parameter_value)
+
+          true
+        rescue
+          false
+        end
+      when :boolean
+        ['true', 'false'].include?(parameter_value.to_s.downcase)
+      when :array
+        parameter_value.is_a?(Array)
+      when :any
+        true
+      end
+    end
+
+    def to_h
+      {
+        parameter_name => parameter_options
+      }
+    end
+  end
+end

data/lib/genome/resource.rb

@@ -3,6 +3,7 @@ require 'active_support/concern'
 require 'active_support/core_ext'
 
 require_relative 'error'
+require_relative 'parameter'
 require_relative 'reference'
 
 module Genome
@@ -11,19 +12,20 @@ module Genome
 
     included do
       class_attribute :templates, default: {}
+      class_attribute :parameters, default: {}
       class_attribute :references, default: []
-      class_attribute :description
+      class_attribute :resource_description
     end
 
     module ClassMethods
-      def template(template_name, template_klass, template_parameters)
-        raise Error::DuplicateTemplate, "Duplicate template name defined '#{template_name}'" if self.templates.key?(template_name)
+      def template(template_name, template_klass, template_properties)
+        raise Error::DuplicateTemplate, "Duplicate template name defined '#{template_name}'" if templates.key?(template_name)
 
-        dependencies = template_parameters.delete(:DependsOn)
+        dependencies = template_properties.delete(:DependsOn)
 
         templates[template_name] = {
           klass: template_klass,
-          parameters: template_parameters,
+          properties: template_properties,
           dependencies: dependencies,
         }
       end
@@ -33,6 +35,22 @@ module Genome
         remove_dependencies(template_name)
       end
 
+      def description(description)
+        @resource_description = description
+      end
+
+      def parameter(parameter_name, parameter_options = {})
+        raise Error::DuplicateParameter, "Duplicate parameter name defined '#{parameter_name}'" if parameters.key?(parameter_name)
+
+        parameters[parameter_name] = Parameter.new(parameter_name: parameter_name, parameter_options: parameter_options)
+      end
+
+      def override_parameter(parameter_name, parameter_options = {})
+        raise Error::MissingParameterName, "Parameter name not defined '#{parameter_name}'" unless parameters.key?(parameter_name)
+
+        parameters[parameter_name].parameter_options.merge!(parameter_options)
+      end
+
       def remove_dependencies(*dependencies)
         templates.each do |template_name, template_parameters|
           dependencies.each do |dependency|

data/lib/genome/resources/documentdb.rb

@@ -11,6 +11,62 @@ module Genome
     class DocumentDB
       include Resource
 
+      parameter :DocumentDBMasterUsername,
+        Default: 'master',
+        NoEcho: "true",
+        Description: "The database admin account username",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "16",
+        AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*",
+        ConstraintDescription: "Must begin with a letter and contain only alphanumeric characters."
+
+      parameter :DocumentDBMasterPassword,
+        Default: 'anotverysecurepassword9876',
+        NoEcho: "true",
+        Description: "The database admin account password",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "41",
+        AllowedPattern: "[a-zA-Z0-9]+",
+        ConstraintDescription: "Must contain only alphanumeric characters."
+
+      parameter :DocumentDBSubnetGroupName,
+        Default: 'documentdb-subnet-group',
+        Description: "Subnet group name",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "64",
+        AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*",
+        ConstraintDescription: "Must begin with a letter and contain only alphanumeric characters."
+
+      parameter :DocumentDBParameterGroupName,
+        Default: 'documentdb-parameter-group',
+        Description: "Parameter group name",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "64",
+        AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*",
+        ConstraintDescription: "Must begin with a letter and contain only alphanumeric characters."
+
+      parameter :DocumentDBClusterIdentifier,
+        Default: 'documentdb-cluster',
+        Description: "Cluster identifier",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "64",
+        AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*",
+        ConstraintDescription: "Must begin with a letter and contain only alphanumeric characters."
+
+      parameter :DocumentDBInstanceIdentifier,
+        Default: 'documentdb-instance',
+        Description: "Instance identifier",
+        Type: "String",
+        MinLength: "1",
+        MaxLength: "64",
+        AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*",
+        ConstraintDescription: "Must begin with a letter and contain only alphanumeric characters."
+
       template :DocumentDBEC2SVPC, Core::Templates::EC2VPC,
         CidrBlock: '10.50.0.0/16',
         EnableDnsSupport: true,
@@ -54,7 +110,7 @@ module Genome
 
       template :DocumentDBSubnetGroup, Core::Templates::DocumentDBSubnetGroup,
         DBSubnetGroupDescription: 'Maintained by Genome: Default DocumentDB Subnet Group',
-        DBSubnetGroupName: 'documentdb-cluster',
+        DBSubnetGroupName: reference(:DocumentDBSubnetGroupName),
         SubnetIds: [
           reference(:DocumentDBEC2SubnetUSEast1A),
           reference(:DocumentDBEC2SubnetUSEast1B),
@@ -71,9 +127,9 @@ module Genome
 
       template :DocumentDBInstance, Core::Templates::DocumentDBInstance,
         AutoMinorVersionUpgrade: true,
-        DBClusterIdentifier: 'documentdb-cluster',
+        DBClusterIdentifier: reference(:DocumentDBClusterIdentifier),
         DBInstanceClass: :'db.r4.large',
-        DBInstanceIdentifier: 'documentdb-instance',
+        DBInstanceIdentifier: reference(:DocumentDBInstanceIdentifier),
         Tags: [
           { Key: :Resource, Value: :DocumentDBCluster }
         ],
@@ -84,7 +140,7 @@ module Genome
       template :DocumentDBParameterGroup, Core::Templates::DocumentDBParameterGroup,
         Description: 'Maintained by Genome: Default DocumentDB Parameter Group',
         Family: 'docdb3.6',
-        Name: 'documentdb-parameter-group',
+        Name: reference(:DocumentDBParameterGroupName),
         Parameters: {
           audit_logs: :enabled,
           tls: :enabled,
@@ -95,11 +151,11 @@ module Genome
         ]
 
       template :DocumentDBCluster, Core::Templates::DocumentDBCluster,
-        DBClusterIdentifier: 'documentdb-cluster',
-        DBClusterParameterGroupName: 'documentdb-parameter-group',
-        DBSubnetGroupName: 'documentdb-cluster',
-        MasterUsername: 'master',
-        MasterUserPassword: 'anotverysecurepassword9876',
+        DBClusterIdentifier: reference(:DocumentDBClusterIdentifier),
+        DBClusterParameterGroupName: reference(:DocumentDBParameterGroupName),
+        DBSubnetGroupName: reference(:DocumentDBSubnetGroupName),
+        MasterUsername: reference(:DocumentDBMasterUsername),
+        MasterUserPassword: reference(:DocumentDBMasterPassword),
         StorageEncrypted: true,
         Tags: [
           { Key: :Resource, Value: :DocumentDBCluster }
@@ -120,19 +176,29 @@ module Genome
         remove_template(:DocumentDBEC2SubnetUSEast1C)
       end
 
+      def self.disable_tls
+        templates[:DocumentDBParameterGroup][:properties][:Parameters].merge!(
+          tls: :disabled
+        )
+      end
+
       def self.subnet_ids(subnet_ids)
-        templates[:DocumentDBSubnetGroup][:parameters][:SubnetIds] = subnet_ids
+        templates[:DocumentDBSubnetGroup][:properties].merge!(
+          SubnetIds: subnet_ids
+        )
       end
 
       def self.security_group_ids(security_group_ids)
-        templates[:DocumentDBCluster][:parameters][:VpcSecurityGroupIds] = security_group_ids
+        templates[:DocumentDBCluster][:properties].merge!(
+          VpcSecurityGroupIds: security_group_ids
+        )
       end
 
       def self.add_cluster_dependencies(*dependencies)
-        cluster_dependencies = templates[:DocumentDBCluster][:parameters][:DependsOn] || []
+        cluster_dependencies = templates[:DocumentDBCluster][:properties][:DependsOn] || []
         cluster_dependencies += dependencies
 
-        templates[:DocumentDBCluster][:parameters][:DependsOn] = cluster_dependencies
+        templates[:DocumentDBCluster][:properties][:DependsOn] = cluster_dependencies
       end
     end
   end

data/lib/genome/version.rb

@@ -1,3 +1,3 @@
 module Genome
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genome
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hypernova2002
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -130,6 +130,7 @@ files:
 - lib/genome/core/templates/ecs_cluster.rb
 - lib/genome/core/templates/sqs_queue.rb
 - lib/genome/error.rb
+- lib/genome/parameter.rb
 - lib/genome/reference.rb
 - lib/genome/resource.rb
 - lib/genome/resources/documentdb.rb
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A library for create and maintaining cloud formation stacks