roro 0.3.0 → 0.3.6

data/lib/roro/cli/generate/generate_keys.rb

@@ -0,0 +1,79 @@
+# require 'openssl'
+# require 'base64'
+# require 'handsome_fencer/crypto'
+
+# module Roro
+
+#   class CLI < Thor
+
+#     include Thor::Actions
+#     include HandsomeFencer::Crypto
+
+#     desc "generate_keys", "Generates keys for all environments. If you have .env files like './**/production.env' and './**/staging.env' this command assumes you need keys for the production and staging environments, and will generate them for you."
+
+#     def generate_keys
+#       generate_key
+#     end
+
+#     desc "generate_key", "Generate a key for each environment"
+#     method_option :environment, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
+
+#     def generate_key(*args)
+#       environments = args.first ? [args.first] : gather_environments
+#       environments.each do |environment|
+#         confirm_files_decrypted?(environment)
+#         create_file "docker/keys/#{environment}.key", encoded_key
+#       end
+#     end
+
+#     no_commands do
+
+#       def encoded_key
+#         @cipher = OpenSSL::Cipher.new 'AES-128-CBC'
+#         @salt = '8 octets'
+#         @new_key = @cipher.random_key
+#         Base64.encode64(@new_key)
+#       end
+
+#       def gather_environments
+#         environments = []
+#         ['.env', '.env.enc'].each do |extension|
+
+#           HandsomeFencer::Crypto.source_files('.', extension).each do |env_file|
+#             environments << env_file.split('/').last.split(extension).last
+#           end
+#         end
+#         environments.uniq
+#       end
+
+#       def confirm_files_decrypted?(environment)
+#         orphan_encrypted = []
+#         HandsomeFencer::Crypto.source_files('.', '.env.enc').each do |file|
+#           orphan_encrypted << file unless File.exist? file.split('.enc').first
+#         end
+
+#         if !orphan_encrypted.empty?
+#           raise Roro::Error.new("You have an encrypted files (.env.enc) #{orphan_encrypted} that do not have corresponding decrypted files (.env). Please decrypt or remove these encrypted files before generating a new key for #{environment}.")
+#         end
+#         true
+#       end
+#     end
+#   end
+
+#   # desc "generate keys", "Generate keys on a per-environment basis"
+#   #
+#   # method_option :environment, type: :string, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
+#   #
+
+#   # def generate_keys
+#   #   default_environments = %w[circleci development production]
+#   #   environments = args.first ? [args.first] : default_environments
+#   #   environments.each do |environment|
+#   #     @cipher = OpenSSL::Cipher.new 'AES-128-CBC'
+#   #     @salt = '8 octets'
+#   #     @new_key = @cipher.random_key
+#   #
+#   #     create_file "docker/keys/#{environment}.key", Base64.encode64(@new_key)
+#   #   end
+#   # end
+# end

data/lib/roro/cli/generate_keys.rb

@@ -16,7 +16,7 @@ module Roro
     end
 
     desc "generate_key", "Generate a key for each environment"
-    method_option :environment, type: :string, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
+    method_option :environment, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
 
     def generate_key(*args)
       environments = args.first ? [args.first] : gather_environments

data/lib/roro/cli/greenfield.rb

@@ -7,90 +7,35 @@ module Roro
     include Thor::Actions
 
     desc "greenfield", "Greenfield a brand new rails app using Docker's instructions"
-
+    
     method_option :env_vars, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "key1:value1 key2:value2"
     method_option :interactive, desc: "Set up your environment variables as you go."
     method_option :force, desc: "force over-write of existing files"
-
+    
+    
     def greenfield
-
+      confirm_directory_empty
       confirm_dependencies
+      remove_roro_artifacts
+      configure_for_greenfielding
       copy_greenfield_files
-      as_system("docker-compose run web rails new . --force --database=postgresql --skip-bundle")
-      chown_if_required
-      as_system('sudo docker-compose build')
-      as_system('mv -f config/database.yml.example config/database.yml')
-      as_system('docker-compose up --build --force-recreate -d ')
-      as_system 'docker-compose run web bin/rails db:create'
+      run_greenfield_commands
     end
-
+    
     no_commands do
-
-      def as_system(command)
-        command = OS.linux? ? "sudo #{command}" : command
-        system command
-      end
-
-      def chown_if_required()
-        warning = "It looks like you're running Docker on some flavor of Linux, in which case the files created by your containers are owned by the root user of the container, and not by the user of the host machine. Please change their ownership by supplying your password at the prompt.",
-        action = "system 'sudo chown -R $USER .'"
-        msg = []
-        msg << ""
-        msg << delineator
-        msg << warning
-        msg << ""
-        msg.join("\n\n")
-        puts msg
-        eval(action)
-      end
-
-      def delineator
-        ("-" * 80)
-      end
-
-      def confirm_dependency(options)
-        msg = []
-        msg << ""
-        msg << delineator
-        msg << "It looks like #{options[:warning]}. The following bash command returns false:"
-        msg << "\t$ #{options[:system_query]}"
-        msg << "Please try these instructions:"
-        msg << ("\t" + options[:suggestion])
-        msg << delineator
-        conditional = options[:conditional] ? eval(options[:conditional]) : system(options[:system_query])
-        if conditional == false
-          raise(Roro::Error.new(msg.join("\n\n")))
-        end
-      end
-
-      def confirm_dependencies
-        dependencies = [
-          {
-            system_query: "ls -A",
-            warning: "this is not an empty directory. Roro will not greenfield a new Rails app unless either a) the current directory is empty or b) you run greenfield with the --force flag",
-            suggestion: "$ roro greenfield --force",
-            conditional: "Dir.glob('*').empty?"
-          }, {
-
-            system_query: "which docker",
-            warning: "Docker isn't installed",
-            suggestion: "https://docs.docker.com/install/"
-          }, {
-            system_query: "which docker-compose",
-            warning: "Docker Compose isn't installed",
-            suggestion: "https://docs.docker.com/compose/install/"
-
-          }, {
-            system_query: "docker info",
-            warning: "the Docker daemon isn't running",
-            suggestion: "https://docs.docker.com/config/daemon/#start-the-daemon-manually"
-          }
-        ]
-
-        dependencies.each do |dependency|
-          confirm_dependency(dependency)
-        end
+      
+      def configure_for_greenfielding
+        @config ||= Roro::Configuration.new(options) 
+      end 
+      
+      def run_greenfield_commands
+        system "DOCKER_BUILDKIT=1 docker build --file Dockerfile --output . ."
+        rollon
       end
+      
+      def copy_greenfield_files
+        template 'greenfield/Dockerfile.tt', 'Dockerfile', @config.app
+      end      
     end
   end
 end

data/lib/roro/cli/rollon.rb

@@ -1,21 +1,84 @@
+require_relative 'rollon/stories'
+
 module Roro
 
   class CLI < Thor
 
-    method_option :env_vars, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "key1:value1 key2:value2"
-    desc "rollon", "Generates files necessary to greenfield a new app within a dockerized rails container, along with a set of files necessary for continuous deployment using CircleCI"
-    method_option :interactive, desc: "Set up your environment variables as you go."
+    desc "rollon", "Generates files for and makes changes to your app 
+      so it can run using Docker containers."
+    method_option :interactive, desc: "Set up your environment variables as 
+      you go."
 
     def rollon
-      configurate
-      if Dir['./*'].empty?
-        raise Roro::Error.new("Oops -- Roro can't roll itself onto a Rails app if it doesn't exist. Please either change into a directory with a Rails app or generate a new one using '$ roro greenfield'.")
+      confirm_directory_not_empty
+      confirm_dependencies
+      remove_roro_artifacts 
+
+      configure_for_rollon
+      
+      copy_roro_files
+      generate_roro_config
+      startup_commands
+    end
+    
+    no_commands do
+     
+      def configure_for_rollon
+        @config ||= Roro::Configuration.new(options) 
+      end
+      
+      def yaml_from_template(file)
+        File.read(File.dirname(__FILE__) + "/templates/#{file}")
+      end
+      
+      def copy_roro_files 
+        configure_database  
+        directory 'roro', './', @config.app
+        template 'base/Dockerfile.tt', 'roro/containers/app/Dockerfile', @config.app
+        take_thor_actions
+      end
+      
+      def take_thor_actions 
+        @config.thor_actions.each {|k, v| eval(k) if v.eql?('y') }  
+      end
+              
+      def startup_commands
+        system 'docker-compose build'
+        system 'docker-compose run web bundle'
+        system 'docker-compose run web bin/rails webpacker:install'
+        system 'docker-compose run web bin/rails yarn:install'
+        system 'docker-compose run web bin/rails db:create'
+        system 'docker-compose run web bin/rails db:migrate'
+        system 'docker-compose up'
+      end
+      
+      def confirm_directory_empty 
+        confirm = confirm_dependency({
+          system_query: "ls -A",
+          warning: "this is not an empty directory. Roro will not greenfield a new Rails app unless either a) the current directory is empty or b) you run greenfield with the --force flag",
+          suggestion: "$ roro greenfield --force",
+          conditional: "Dir.glob('*').empty?" }) 
+        confirm || true
       end
-      copy_base_files
-      append_to_existing_files
-      insert_into_file 'Gemfile', "gem 'sshkit'\n\n", before: "group :development, :test do"
-      insert_into_file 'Gemfile', "\n\tgem 'handsome_fencer-test'", after: "group :development, :test do"
 
+    
+      def confirm_dependency(options)
+        msg = []
+        msg << ""
+        msg << delineator
+        msg << "It looks like #{options[:warning]}. The following bash command returns false:"
+        msg << "\t$ #{options[:system_query]}"
+        msg << "Please try these instructions:"
+        msg << ("\t" + options[:suggestion])
+        msg << delineator
+        conditional = options[:conditional] ? eval(options[:conditional]) : system(options[:system_query])
+        if conditional == false
+          raise(Roro::Error.new(msg.join("\n\n")))
+        else 
+          true 
+        end
+      end
+      
     end
   end
-end
+end

data/lib/roro/cli/rollon/database/database.rb

@@ -0,0 +1,31 @@
+module Roro
+
+  class CLI < Thor
+
+    no_commands do
+
+      def configure_database 
+        database = @config.thor_actions['configure_database']
+        vendor = @config.master['services']['database']['vendors']
+        case database
+        when 'p'
+          @config.app['database_vendor'] = 'postgresql'
+          @config.app['postgresql_env_vars'] = vendor['postgresql']['env_vars']
+          configure_for_pg
+        when 'm'
+          @config.app['database_vendor'] = 'mysql'
+          @config.app['mysql_env_vars'] = vendor['mysql']['env_vars']
+          configure_for_mysql
+        end
+        
+        %w(development production test staging ci).each do |environment| 
+          template(
+            'base/.env/web.env.tt',
+            "roro/containers/app/#{environment}.env", @config.app
+          )
+        end
+      end
+    end 
+  end 
+end
+      

data/lib/roro/cli/rollon/database/with_mysql.rb

@@ -0,0 +1,22 @@
+module Roro
+
+  class CLI < Thor
+
+    no_commands do
+      
+      def configure_for_mysql 
+        insert_db_gem('mysql2')
+        copy_file 'base/config/database.mysql.yml', 'config/database.yml', force: true
+        config = @config.app.clone
+
+        %w(development production test staging ci).each do |environment| 
+          config['rails_env'] = environment
+          
+          source = 'base/.env/database.mysql.env.tt'
+          target = "roro/containers/database/#{environment}.env" 
+          template( source, target, config )
+        end
+      end
+    end
+  end
+end

data/lib/roro/cli/rollon/database/with_postgres.rb

@@ -0,0 +1,21 @@
+module Roro
+
+  class CLI < Thor
+
+    no_commands do
+      
+      def configure_for_pg 
+        insert_db_gem('pg')
+        copy_file 'base/config/database.pg.yml', 'config/database.yml', force: true
+        config = @config.app.clone
+        %w(development production test staging ci).each do |environment| 
+          config['rails_env'] = environment
+          
+          source = 'base/.env/database.pg.env.tt'
+          target = "roro/containers/database/#{environment}.env" 
+          template( source, target, config )
+        end
+      end
+    end
+  end
+end

data/lib/roro/cli/rollon/stories.rb

@@ -0,0 +1,3 @@
+require_relative 'database/with_postgres.rb'
+require_relative 'database/with_mysql.rb'
+require_relative 'database/database.rb'

data/lib/roro/cli/roro_configurator.yml

@@ -0,0 +1,157 @@
+---
+main_app_name: <%= Dir.pwd.split('/').last  %>
+developer: 
+  name: your-name
+  email: your.email@example.com
+
+services:
+  server_app:
+    name: app 
+    vendors: 
+      rails:
+        version: 
+        image: 
+          official_name: ruby
+          variants: 
+            - alpine
+            - buster 
+            - slim
+            - slim-buster
+            - stretch
+
+        choices:
+          
+          config_std_out_true: 
+            question: |
+              The team at Heroku, among others, recommend logging to STDOUT 
+              and treating your logs as streams. We'll set this to 
+              true as an environment variable but it may also be helpful
+              to configure './config/boot.rb' with '$stdout.sync = true' 
+              just in case that doesn't work. 
+              Would you like to configure this? 
+            choices: 
+              y: 'Yes'
+              n: 'No'
+            default: y
+
+          insert_roro_gem_into_gemfile: 
+            question: |
+              Many developers believe it's good idea to secure sensitive 
+              environment files and variables. You can use RoRo to 
+              generate secret keys known only to you for use in any
+              environment, and then use them to encrypt and decrypt 
+              these files. Would you like to add RoRo to your Gemfile?
+            choices: 
+              y: 'Yes'
+              n: 'No'
+            default: y
+                
+          gitignore_sensitive_files:
+            question: | 
+              If you plan to use the environment files RoRo generates for 
+              your own environment variables, it's a good idea to keep 
+              these files out of source control. Would you like RoRo to 
+              modify your .gitignore file to accomplish this for you ?
+            choices: 
+              y: 'Yes'
+              n: 'No'
+            default: y
+              
+          insert_hfci_gem_into_gemfile: 
+            question: | 
+              Jim Weirich passed too soon and remains missed. In addition 
+              to Rake, Jim wrote a beautiful gem called 'Given' that makes 
+              Rspec and Minitest less ugly and thus your tests more easy to 
+              write. Would you like to install a gem called 
+              handsome_fencer-test that allows you to try it out?
+            choices: 
+              y: 'Yes'
+              n: 'No' 
+            default: n
+              
+          backup_existing_files: 
+            question: |
+              RoRo will be generating a number of files, some of which will 
+              replace existing ones. Would you like to back them up?
+            choices: 
+              y: 'Yes'
+              n: 'No' 
+            default: n
+
+          copy_dockerignore:
+            question: |
+              Would you like to create a .dockerignore file?
+            choices: 
+              y: 'Yes'
+              n: 'No'
+            default: y
+            
+          configure_database:
+            question: |
+              RoRo can reliably dockerize your Rails app with either 
+              MySQL or PostgreSQL stories. Which story would you prefer
+              to roll on?
+            choices:
+              p: PostgreSQL
+              m: MySQL 
+            default: p
+
+        env_vars: 
+          DATABASE_HOST: database
+  
+  database:
+    name: database
+    vendor: postgresql
+    vendors: 
+      postgresql:
+        images: 
+          official_name: 
+          versions: 
+            - latest 
+        env_vars: 
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: your-postgres-password
+
+      mysql: 
+        env_vars: 
+          MYSQL_ROOT_PASSWORD: root 
+          MYSQL_PASSWORD: root
+          MYSQL_USERNAME: root
+          MYSQL_DATABASE_PORT: '3306'
+      
+  frontend:
+    name: frontend
+    vendors: 
+       
+      - frontend
+      - vuejs
+      - react
+      - angular
+  webserver: 
+    default: nginx
+    vendors: 
+      - nginx
+  application_server:
+    name: appserver 
+    vendors: 
+      - unicorn:
+      - puma: 
+registries: 
+  dockerhub:
+    env_vars: 
+      DOCKERHUB_EMAIL: your-docker-hub-email
+      DOCKERHUB_ORG: your-docker-hub-org-name
+      DOCKERHUB_PASSWORD: your-docker-hub-password
+      DOCKERHUB_USER: your-docker-hub-user-name
+    
+ci_cd:
+  semaphore:
+  circleci:
+    env_vars:
+      DEPLOY_TAG: "${CIRCLE_SHA1:0:7}"
+
+deployment:
+  env_vars: 
+    SERVER_HOST: "ip-address-of-your-server"
+    SERVER_PORT: '22'
+    SERVER_USER: root