satorix 0.0.1 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f677f81f64b5f6c8e17e151b2b2be516cb736ff1
-  data.tar.gz: 55632c8146b1748a25c56b45c2def07e7f6d5902
+SHA256:
+  metadata.gz: 9088dfa5e536b94cd4ab988c4201161bb2d830a7ff2417885cd51819457d5b46
+  data.tar.gz: 184dcbd4d9ed1c939e293a1186ea9db8189d9cc527e9db3f75add9b02b02dc94
 SHA512:
-  metadata.gz: 571f0d7f89ee278d5d06be705e2cc910cd925cdc3642d23f12e852d0542fcac31222c4abf20a8c5475163a14785db243b0d4a8787f84f0ff308dd9e75ecb4af5
-  data.tar.gz: 4ed70556edd92e3d2a08a6f08e3e54f85fe569c37134748e5483ce201d5f4956d99e8a2a9c54c5eb9dde8c32dc1179506c510ceb26ddd2882d9ed830329d0724
+  metadata.gz: 803dd33cf23c8febee87bb48c0546b304afb1b286be05827a171e4a08bbc23e7c2967692f819d89ea255d3ca751d0052dd38ad0bb7a44e8268bffe4a51745bca
+  data.tar.gz: c1b2517847dc98193ec4fe56383299d803aff291a5858fa2e1057753ae1c4ecf2031093e453e510a58442d38c4fc5ea01c6e84841fed870a201de40d782c9cdd

data/.gitignore

@@ -1,9 +1,12 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+# Ruymine/development files
+.idea
+clean_branches.rb

data/.gitlab-ci.yml

@@ -0,0 +1,45 @@
+image: 'satorix/base'
+
+cache:
+  key: "$CI_PROJECT_ID"
+  paths:
+    - 'tmp/satorix/cache' # To cache buildpack gems between runs.
+
+
+.satorix: &satorix
+  script:
+    - gem install satorix --source https://gems.iexposure.com --no-document
+    - satorix
+
+
+# bundler-audit
+# Patch-level verification for Bundler
+# https://github.com/rubysec/bundler-audit
+bundler_audit:
+  <<: *satorix
+
+
+# RSpec
+# Behaviour Driven Development for Ruby
+# http://rspec.info/
+rspec:
+  <<: *satorix
+
+
+# RuboCop
+# A Ruby static code analyzer, based on the community Ruby style guide.
+# https://github.com/bbatsov/rubocop
+rubocop:
+  <<: *satorix
+  allow_failure: true
+
+
+
+# This is a custom job, defined at satorix/CI/deploy/rubygems.rb
+deploy_to_rubygems:
+  stage: deploy
+  only:
+    - master
+  except:
+    - schedules
+  <<: *satorix

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
+--format progress
+--order rand
 --color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/ModuleFunction:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.6

data/Gemfile

@@ -1,3 +1,5 @@
+ruby File.open("#{ File.dirname(__FILE__) }/.ruby-version", &:gets).strip[/ruby-(.+)/i, 1]
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in satorix.gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    satorix (1.5.3)
+      airbrake-ruby
+      bundler (~> 1.13)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrake-ruby (2.0.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  satorix!
+
+RUBY VERSION
+   ruby 2.6.6p146
+
+BUNDLED WITH
+   1.17.3

data/Procfile

@@ -0,0 +1 @@
+# This is an empty file, to silence an buildpack warning during testing.

data/README.md

@@ -1,3 +1,95 @@
 # Satorix
 
-By [Internet Exposure](https://www.iexposure.com/)
+By [Satorix](https://www.satorix.com/)
+
+[![build](http://gitlab.iexposure.com/satorix/satorix/badges/master/build.svg)](http://gitlab.iexposure.com/satorix/satorix/pipelines)
+[![coverage](http://gitlab.iexposure.com/satorix/satorix/badges/master/coverage.svg)](http://gitlab.iexposure.com/satorix/satorix/pipelines)
+
+This gem is a commandline tool used to tie together SCM, CI/CD, and hosting environments. 
+
+## Installation
+
+Install Satorix from the command line:
+
+    $ gem install satorix
+
+## Usage
+
+Run Satorix from the command line:
+
+    $ satorix
+
+Note: Satorix is currently designed to be run via GitLab CI, not locally.
+
+## Application Preparation
+
+To prepare your application:
+
+[Satorix Docs](https://www.satorix.com/docs)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `bundle exec rspec spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+
+## CI/CD
+
+Satorix is used to provide continuous integration and continuous deployment for this application.
+
+CI is run against every push. 
+
+CD is used to automatically build and deploy the gem for the master branch.
+
+## Environment Variables
+ 
+ Satorix uses environment variables as an authoritative source for application configuration.
+ 
+ Environment variables are named with the scheme of PREFIX_BRANCH_KEY.
+ 
+ 
+### Application (AEEV)
+
+ Application-level environment variables are identified by the AEEV prefix (Application Exportable Environment Variable).
+ 
+ These environment variables are passed to the Satorix Hosting Evnvironment for consumption by the application. A
+ likely use case would be secrets.yml 
+ 
+ The prefix and branch are removed. 
+ 
+  
+ * AEEV_PRODUCTION_SECRET_API_KEY
+ * AEEV_STAGING_SECRET_API_KEY
+ 
+ The variable name passed to the application in the respective environment would be SECRET_API_KEY
+ 
+ 
+### Flynn (FLYNN)
+
+Environment variables used to configure Flynn are identified by the FLYNN prefix.
+
+#### Required 
+
+* DOMAIN
+* KEY
+* TLSPIN
+
+#### Optional
+
+* SCALE
+* RESOURCES
+ 
+### Domain (DDEV, CRT, KEY)
+
+Domain information can be configured with environment variables identified by the DOMAIN prefix.
+
+* KEY_PRODUCTION_DOMAINDOM
+* CRT_PRODUCTION_DOMAINDOM
+* DDEV_PRODUCTION_DOMAINDOM
+* KEY_PRODUCTION_DEFAULT
+* CRT_PRODUCTION_DEFAULT
+

data/Rakefile

@@ -1,6 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+  RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "satorix"
+require 'bundler/setup'
+require 'satorix'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "satorix"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/satorix

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+#Adjust path in case called directly and not through gem
+$:.unshift "#{File.expand_path(File.dirname(__FILE__))}/../lib"
+
+require 'satorix'
+
+Satorix.go

data/lib/satorix/CI/deploy/flynn/environment_variables.rb

@@ -0,0 +1,123 @@
+require 'yaml'
+
+module Satorix
+  module CI
+    module Deploy
+      module Flynn
+        module EnvironmentVariables
+
+
+          def adjust_env_vars
+            ensure_required_env_vars_are_defined unless ENV["SATORIX_#{ current_branch }_ENFORCE_ENV_VAR_DEFINITION"] == 'false'
+            env_unset
+            env_set
+          end
+
+
+          def aeev_key_exists?
+            !(run_command('flynn env', quiet: true) =~ /#{ exported_aeevs_key }=/mi).nil?
+          end
+
+
+          def aeev_prefix
+            # AEEV - Application Exportable Environment Variable
+            "AEEV_#{ current_branch }_"
+          end
+
+
+          def ci_provided_env_vars
+            {}.tap do |vars|
+              ENV.each do |key, value|
+                vars[key.sub(aeev_prefix, '')] = value.sub('***EMPTY_STRING***', '') if key.start_with?(aeev_prefix)
+              end
+            end
+          end
+
+
+          def current_flynn_keys
+            aeev_key_exists? ? run_command("flynn env get #{ exported_aeevs_key }", quiet: true).split : []
+          end
+
+
+          def desired_env_vars
+            ci_provided_env_vars.tap do |vars|
+              vars[exported_aeevs_key] = (vars.keys << exported_aeevs_key).sort.join("\n")
+            end
+          end
+
+
+          def ensure_required_env_vars_are_defined(configuration_file: 'config/secrets.yml')
+            # TODO : handle new Rails secrets methods, like encrypted secrets
+            if File.file?(configuration_file)
+              secrets = YAML.load_file(configuration_file)
+
+              all_secrets = {}
+              all_secrets.merge!(secrets['shared']) if secrets['shared']
+              all_secrets.merge!(secrets['production']) if secrets['production']
+
+              required = all_secrets.to_yaml.scan(/ENV\[['"](?<var>[A-Z0-9_.]+)['"]\]/).flatten.uniq
+              set = ci_provided_env_vars.keys
+
+              missing = required - set
+
+              if missing.empty?
+                log "All required environment variables from #{ configuration_file } have been defined."
+              else
+                log_error "Environment variables specified in #{ configuration_file } were not defined for the #{ current_branch.downcase } branch."
+                log_error "\nPlease define the following variables in your dashboard:\n#{ missing.join("\n") }\n"
+                log_error_and_abort 'Missing required environment variables.'
+              end
+            else
+              log "No #{ configuration_file } exists, skipping environment variable enforcement."
+            end
+          end
+
+
+          def env_set
+            if env_vars_to_set.empty?
+              log 'No new environment variables to set.'
+            else
+              keys_and_values = env_vars_to_set.map { |k, v| "#{ k }=#{ v }" }
+              run_command(['flynn', 'env', 'set', keys_and_values].flatten, filtered_text: env_vars_to_set.values)
+            end
+          end
+
+
+          def env_unset
+            if env_vars_to_unset.empty?
+              log 'No existing environment variables to unset.'
+            else
+              run_command "flynn env unset #{ env_vars_to_unset.join(' ') }"
+            end
+          end
+
+
+          def env_vars
+            @_env_vars ||= begin
+              {}.tap do |vars|
+                current_flynn_keys.each { |key| vars[key] = run_command("flynn env get #{ key }", quiet: true).chomp }
+              end
+            end
+          end
+
+
+          def env_vars_to_set
+            @_env_vars_to_set ||= desired_env_vars.reject { |k, v| env_vars.key?(k) && env_vars[k] == v }
+          end
+
+
+          def env_vars_to_unset
+            @_env_vars_to_unset ||= env_vars.keys - desired_env_vars.keys
+          end
+
+
+          def exported_aeevs_key
+            'AEEV_KEYS'
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/deploy/flynn/resources.rb

@@ -0,0 +1,79 @@
+module Satorix
+  module CI
+    module Deploy
+      module Flynn
+        module Resources
+
+
+          def add_resources
+            if resources_to_add.empty?
+              log 'No resources to add.'
+            else
+              resources_to_add.each { |resource| run_command "flynn resource add #{ resource }" }
+            end
+          end
+
+
+          def available_resources
+            %w(postgres mysql mongodb redis)
+          end
+
+
+          def current_resource_provider_names
+            resource.split("\n").drop(1).map(&:split).map(&:last)
+          end
+
+
+          def desired_resource_provider_names
+            names = ENV[resource_provider_key].to_s.split
+            disallowed = names - available_resources
+            unless disallowed.empty?
+              log_error_and_abort("Invalid resource#{ 's' if disallowed.length > 1 }: #{ disallowed.join(' ') }")
+            end
+            names
+          end
+
+
+          def remove_resources
+            if resources_to_remove.empty?
+              log 'No resources to remove.'
+            else
+              log "The following previously allocated resources are no longer defined in #{ resource_provider_key }:"
+              log resources_to_remove.join(' ')
+              log ''
+              log 'To remove them, use the flynn resource command: https://flynn.io/docs/cli#resource'
+            end
+          end
+
+
+          def resource
+            run_command('flynn resource', quiet: true).chomp
+          end
+
+
+          def resource_provider_key
+            "FLYNN_#{ current_branch }_RESOURCES"
+          end
+
+
+          def resources_to_add
+            desired_resource_provider_names - current_resource_provider_names
+          end
+
+
+          def resources_to_remove
+            current_resource_provider_names - desired_resource_provider_names
+          end
+
+
+          def set_resources
+            add_resources
+            remove_resources
+          end
+
+
+        end
+      end
+    end
+  end
+end