satorix 0.0.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f677f81f64b5f6c8e17e151b2b2be516cb736ff1
-  data.tar.gz: 55632c8146b1748a25c56b45c2def07e7f6d5902
+SHA256:
+  metadata.gz: 274dbd65366f3a703d2a57b81524f4aa9aa9522b0caa2f2b8158758b20c1861c
+  data.tar.gz: 3fb98c60b4e33c30d053d23c6833d39e809c6d9da4785475694b554e974a9699
 SHA512:
-  metadata.gz: 571f0d7f89ee278d5d06be705e2cc910cd925cdc3642d23f12e852d0542fcac31222c4abf20a8c5475163a14785db243b0d4a8787f84f0ff308dd9e75ecb4af5
-  data.tar.gz: 4ed70556edd92e3d2a08a6f08e3e54f85fe569c37134748e5483ce201d5f4956d99e8a2a9c54c5eb9dde8c32dc1179506c510ceb26ddd2882d9ed830329d0724
+  metadata.gz: 77f3d4a3a876d26f1d335936e4d613dad6280cbff9367d31672a2b56df16086c074ba066a1b11760a802d9a357491e1275d81bb09473726716dffc47f1798de8
+  data.tar.gz: 22aefe7ba2cb3a806b44635e8554762a912283a66cb7f6628a16937e1e3e166ce7437ae38e13471722c2e5cbc196d043d6f1c33886990a5771ac974f0c6c4ada

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:
+    - tags
+  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.6.0)
+      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.rb

@@ -1,5 +1,341 @@
-require "satorix/version"
+require 'airbrake-ruby'
+require 'English' # http://ruby-doc.org/stdlib-2.0.0/libdoc/English/rdoc/English.html
+require 'satorix/version'
+require 'etc'
 
 module Satorix
-  # Your code goes here...
+
+  module Shared
+    autoload :Console, 'satorix/shared/console'
+  end
+
+  module CI
+
+    module Deploy
+      autoload :Flynn, 'satorix/CI/deploy/flynn'
+    end
+
+    module Shared
+      autoload :BuildpackManager, 'satorix/CI/shared/buildpack_manager'
+      module BuildpackManager
+        autoload :Buildpack, 'satorix/CI/shared/buildpack_manager/buildpack'
+      end
+      autoload :YarnManager, 'satorix/CI/shared/yarn_manager'
+
+      module Ruby
+        autoload :GemManager, 'satorix/CI/shared/ruby/gem_manager'
+      end
+    end
+
+    module Test
+      module Python
+        autoload :DjangoTest, 'satorix/CI/test/python/django_test'
+        autoload :Safety, 'satorix/CI/test/python/safety'
+      end
+
+      module Ruby
+        autoload :Brakeman, 'satorix/CI/test/ruby/brakeman'
+        autoload :BundlerAudit, 'satorix/CI/test/ruby/bundler_audit'
+        autoload :Cucumber, 'satorix/CI/test/ruby/cucumber'
+        autoload :RailsTest, 'satorix/CI/test/ruby/rails_test'
+        autoload :Rspec, 'satorix/CI/test/ruby/rspec'
+        autoload :Rubocop, 'satorix/CI/test/ruby/rubocop'
+      end
+
+      module Shared
+        autoload :Database, 'satorix/CI/test/shared/database'
+      end
+    end
+
+  end
+
+  include Satorix::Shared::Console
+
+  extend self
+
+
+  def go
+    airbrake_start
+    prepare_app_environment
+
+    begin
+      log_header "Executing #{ ci_job_name } script for #{ ci_commit_ref_name }..."
+
+      execute_as_user 'satorix' do
+        Dir.chdir(build_dir)
+        unless skip_buildpack?
+          Satorix::CI::Shared::BuildpackManager.go
+          Dir.chdir(app_dir)
+        end
+        Satorix::CI::Shared::Ruby::GemManager.go if ruby_gem?
+        Satorix::CI::Shared::YarnManager.go if yarn?
+
+        job_class.go
+      end
+
+      log_header "\nDone executing #{ ci_job_name } script for #{ ci_commit_ref_name }.\n"
+    rescue Exception => e
+      # TODO: add link to issue tracker
+      log 'If you feel this failure was in error, please check the issue tracker for more information.'
+      Airbrake.notify(e) if airbrake_configured?
+      raise e
+    end
+  end
+
+
+  def add_user(username)
+    unless user_exists?(username)
+      run_command(['useradd', '--user-group', '--comment', "'#{ username } user'", '--shell', '/bin/bash', '--home', app_dir, username], quiet: true)
+    end
+  end
+
+
+  def user_exists?(username)
+    Etc.getpwnam(username)
+  rescue
+  end
+
+
+  def airbrake_configured?
+    [airbrake_project_id, airbrake_project_key].all? { |var| !var.empty? }
+  end
+
+
+  def airbrake_project_id
+    ENV['SATORIX_CI_AIRBRAKE_PROJECT_ID'].to_s
+  end
+
+
+  def airbrake_project_key
+    ENV['SATORIX_CI_AIRBRAKE_PROJECT_KEY'].to_s
+  end
+
+
+  def airbrake_start
+    return unless airbrake_configured?
+
+    Airbrake.configure do |c|
+      c.project_id = airbrake_project_id
+      c.project_key = airbrake_project_key
+    end
+
+    at_exit do
+      Airbrake.notify_sync($ERROR_INFO) if $ERROR_INFO # https://github.com/airbrake/airbrake-ruby#reporting-critical-exceptions
+      Airbrake.close # https://github.com/airbrake/airbrake-ruby#airbrakeclose
+    end
+  end
+
+
+  def custom_loader_relative_path
+    File.join 'satorix', 'custom.rb'
+  end
+
+
+  def custom_loader_full_path
+    File.join build_dir, custom_loader_relative_path
+  end
+
+
+  def load_custom
+    log_bench "Looking for custom job definitions in #{ custom_loader_relative_path }....." do
+      if File.exist? custom_loader_full_path
+        log "Loading custom job definitions from #{ custom_loader_relative_path }."
+        require custom_loader_full_path
+        Satorix::Custom.available_jobs
+      else
+        # TODO : create this documentation and link to it in the message below
+        log 'No custom jobs found.'
+        log "You can define custom jobs by adding a #{ custom_loader_relative_path } file to your app root."
+        log 'For more information, please refer to https://www.satorix.com/docs/articles/custom_satorix_jobs.'
+        {}
+      end
+    end
+  end
+
+
+  def default_jobs
+    { deploy: { deploy_with_flynn: Satorix::CI::Deploy::Flynn },
+      test: { brakeman: Satorix::CI::Test::Ruby::Brakeman,
+              bundler_audit: Satorix::CI::Test::Ruby::BundlerAudit,
+              cucumber: Satorix::CI::Test::Ruby::Cucumber,
+              django_test: Satorix::CI::Test::Python::DjangoTest,
+              rails_test: Satorix::CI::Test::Ruby::RailsTest,
+              rspec: Satorix::CI::Test::Ruby::Rspec,
+              rubocop: Satorix::CI::Test::Ruby::Rubocop,
+              safety: Satorix::CI::Test::Python::Safety } }
+  end
+
+
+  def available_jobs
+    @_available_jobs ||= load_custom.tap do |jobs|
+      default_jobs.each do |stage, job_definitions|
+        jobs[stage] ||= {}
+        job_definitions.each { |job, target| jobs[stage][job] = target }
+      end
+    end
+  end
+
+
+  def ci_job_name
+    ENV['CI_JOB_NAME']
+  end
+
+
+  def ci_job_stage
+    ENV['CI_JOB_STAGE']
+  end
+
+
+  def ci_commit_ref_name
+    ENV['CI_COMMIT_REF_NAME']
+  end
+
+
+  def ci_commit_sha
+    ENV['CI_COMMIT_SHA']
+  end
+
+
+  def current_branch
+    @_current_branch ||= ci_commit_ref_name.to_s.upcase
+  end
+
+
+  def job_class
+    available_jobs[ci_job_stage.to_sym] && available_jobs[ci_job_stage.to_sym][ci_job_name.to_sym] || begin
+                                                                                                        log_error_and_abort "The #{ ci_job_name } job does not exist for the #{ ci_job_stage } stage!"
+                                                                                                      end
+  end
+
+
+  # https://stackoverflow.com/questions/4548151/run-ruby-block-as-specific-os-user/
+  def execute_as_user(user, &block)
+    u = (user.is_a? Integer) ? Etc.getpwuid(user) : Etc.getpwnam(user)
+
+    ENV['HOME'] = Satorix.app_dir
+
+    reader, writer = IO.pipe
+
+    Process.fork do
+      # the child process won't need to read from the pipe
+      reader.close
+
+      # use primary group ID of target user
+      # This needs to be done first as we won't have
+      # permission to change our group after changing EUID
+      Process.gid = Process.egid = u.gid
+
+      # set real and effective UIDs to target user
+      Process.uid = Process.euid = u.uid
+
+      # get the result and write it to the IPC pipe
+      result = block.call(user)
+      Marshal.dump(result, writer)
+      writer.close
+
+      # prevent shutdown hooks from running
+      Process.exit!(true)
+    end
+
+    # back to reality... we won't be writing anything
+    writer.close
+
+    # block until there's data to read
+    result = Marshal.load(reader)
+
+    # done with that!
+    reader.close
+
+    # return block result
+    result
+  rescue EOFError
+    log_error 'This job has failed.'
+    abort
+  end
+
+
+  def paths
+    ci_project_dir = ENV['CI_PROJECT_DIR'].to_s
+    { buildpacks: '/tmp/buildpacks',
+      app_dir: '/tmp/app',
+      build_dir: ci_project_dir,
+      cache: File.join(ci_project_dir, 'tmp', 'satorix', 'cache'),
+      env: '/tmp/env' }
+  end
+
+
+  def app_dir
+    paths[:app_dir]
+  end
+
+
+  def bin_dir
+    File.join app_dir, 'bin'
+  end
+
+
+  def build_dir
+    paths[:build_dir]
+  end
+
+
+  def prepare_app_environment
+    log_bench 'Preparing app environment...' do
+      add_user('satorix')
+      setup_directories
+    end
+  end
+
+
+  def project_name
+    ENV['CI_PROJECT_NAME']
+  end
+
+
+  def setup_directories
+    paths.values.each { |path| FileUtils.mkdir_p path }
+    paths.values.each { |path| FileUtils.chown_R 'satorix', 'satorix', path }
+    FileUtils.ln_s app_dir, '/app'
+  end
+
+
+  def skip_buildpack?
+    job_class.respond_to?(:skip_buildpack) && job_class.skip_buildpack
+  end
+
+
+  def yarn?
+    File.exist? yarn_lock_file
+  end
+
+
+  def yarn_lock_file
+    File.join(app_dir, 'yarn.lock')
+  end
+
+
+  def rails_app?
+    # This used to follow the Heroku buildpack, with:
+    # File.exist?(File.join(build_dir, 'Gemfile'))
+    # It has been adjusted to accommodate non-rails apps that use ruby gems.
+    # The config/application.rb file seems to be present in all rails applications.
+    # It may be useful to add additional checks, for increased precision, in the future.
+    File.exist?(File.join(build_dir, 'config', 'application.rb'))
+  end
+
+
+  def django_app?
+    # Satorix requires django apps be in a public directory.
+    # The manage.py file seems to be present in all django applications.
+    # It may be useful to add additional checks, for increased precision, in the future.
+    File.exist?(File.join(build_dir, 'public', 'manage.py'))
+  end
+
+
+  def ruby_gem?
+    # Checks for the presence of a *.gemspec file in the project root.
+    # It may be useful to add additional checks, for increased precision, in the future.
+    Dir[File.join(build_dir, '*.gemspec')].any?
+  end
+
 end