roro 0.3.17 → 0.3.23

data/lib/roro/stacks/stories_v1/rollon/rails/database.yml

@@ -0,0 +1,9 @@
+stories: postgresql
+
+actions: 
+  - |
+    Roro::CLI.roro_environments.each do |environment| 
+      src = 'rails/dotenv/web.env.tt'
+      dest = "roro/containers/app/#{environment}.env"
+      template src, dest, @config.env
+    end

data/lib/roro/stacks/stories_v1/rollon/rails/kubernetes/postgresql/default.yml

@@ -0,0 +1 @@
+actions:

data/lib/roro/stacks/stories_v1/rollon/rails/kubernetes/postgresql/edge.yml

@@ -0,0 +1 @@
+actions:

data/lib/roro/stacks/stories_v1/rollon/rails/kubernetes/postgresql.yml

@@ -0,0 +1,10 @@
+stories: 
+  - default 
+  - edge
+
+actions: 
+  - template 'rails/.circleci/config.yml.tt', './.circleci/config.yml' 
+  - template 'rails/preface-returns-array_of_strings.yml.tt', './preface-returns-array_of_strings.yml', @config.smart.env
+  - template 'base/dotenv', './.smart.env', @config.smart.env
+  - directory 'rails/roro', './roro', @config.smart.env
+  - template 'rails/kube.rake.tt', './lib/tasks/kube.rake', @config.smart.env

data/lib/roro/stacks/stories_v1/rollon/rails/kubernetes.yml

@@ -0,0 +1 @@
+stories: postgresql

data/lib/roro/stacks/stories_v1/rollon/rails.yml

@@ -0,0 +1,76 @@
+stories: 
+  - database  
+  - ci_cd
+  - kubernetes
+
+actions: 
+  - template 'rails/.circleci/config.yml.tt', './.circleci/config.yml' 
+  - template 'rails/preface-returns-array_of_strings.yml.tt', './preface-returns-array_of_strings.yml', @config.smart.env
+  - template 'base/dotenv', './.smart.env', @config.smart.env
+  - directory 'rails/roro', './roro', @config.smart.env
+  - chmod "roro/docker-entrypoint.sh", 0755
+
+
+startup: 
+  success: "Your backend should be available at http://localhost:3000"
+  commands: 
+    - docker-compose build --no-cache
+    - docker-compose up -d
+    - docker-compose run backend bin/rails db:create
+    - docker-compose run backend bin/rails db:migrate
+    - 'docker-compose run backend echo #{success_msg}'
+
+env_vars: 
+  ruby_version: '2.7'
+  database_host: database
+  frontend_service: frontend
+  database_service: database
+
+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: n
+        
+  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

data/lib/roro/stacks/stories_v1/rollon/roro.yml

@@ -0,0 +1,5 @@
+greenfield_actions:
+  - |
+    src = 'roro'
+    dest = 'roro'
+    template src, dest, @config.env

data/lib/roro/stacks/stories_v1/rollon/ruby_gem.yml

@@ -0,0 +1,5 @@
+story: 
+  ci_cd: circleci
+env_vars: 
+  ruby_version: '2.7'
+  

data/lib/roro/stacks/stories_v1/rollon.yml

@@ -0,0 +1,42 @@
+stories: rails
+
+intentions: 
+
+env_vars: 
+  main_app_name: 
+  developer: 
+    name: your-name
+    email: your.email@example.com
+  docker_email: your-docker-registry-email
+  docker_org: your-docker-registry-org-name
+  docker_password: your-docker-registry-password
+  docker_token: your-docker-registry-token
+  docker_username: your-docker-registry-user-name
+    
+choices:
+  
+  generate_config_story:
+    question: |
+      Would you like to create a Roro Config file to help with debugging, 
+      sharing your desired story, or both?
+    choices: 
+      y: 'Yes'
+      n: 'No'
+    default: y 
+      
+  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

data/lib/roro/{cli → stacks/stories_v1}/templates/rails/.circleci/config.yml.tt

@@ -1,13 +1,11 @@
-<%= yaml_from_template("rails/.circleci/_aliases.yml") %>
-
+<%= yaml_from_template("base/.circleci/_version.yml") %>
 <%= yaml_from_template("base/.circleci/_defaults.yml") %>
+<%= yaml_from_template("base/.circleci/_major_only.yml") %>
+<%= yaml_from_template("base/.circleci/_executors.yml") %>
+<%= yaml_from_template("base/.circleci/_commands.yml") %>
 
 <%= yaml_from_template("rails/.circleci/jobs/_build.yml") %>
-  
 <%= yaml_from_template("rails/.circleci/jobs/_test.yml") %>
-
 <%= yaml_from_template("rails/.circleci/jobs/_push.yml") %>
-       
 <%= yaml_from_template("base/.circleci/_workflow.yml") %>
-
 <%= yaml_from_template("rails/.circleci/workflows/_build_test_push.yml") %>

data/lib/roro/{cli → stacks/stories_v1}/templates/rails/.circleci/jobs/_build.yml

@@ -1,16 +1,14 @@
+jobs:
   build:
     <<: *defaults 
     steps:
       - checkout
-      - run: |
-          gem install roro 
-          roro generate::exposed ci
+      - run: gem install roro
+      - run: roro generate::exposed ci
       - run: | 
           mkdir -p workspace 
           cp -r roro workspace/
       - persist_to_workspace: 
           root: workspace 
           paths:  
-            - roro
-      - run: *source-ci-variables
-      - run: RORO_ENV=ci docker-compose build
+            - roro

data/lib/roro/stacks/stories_v1/templates/rails/.circleci/jobs/_push.yml

@@ -0,0 +1,11 @@
+  push:
+    <<: *defaults
+    steps:
+      - checkout
+      - attach-roro
+      - run: docker-compose build
+      - run: docker login -u ${DOCKER_USER} -p ${DOCKER_PASS}
+      - tag-and-push: 
+          deploy_tag: ${DEPLOY_TAG}
+      - tag-and-push: 
+          deploy_tag: 'latest'

data/lib/roro/stacks/stories_v1/templates/rails/.circleci/jobs/_test.yml

@@ -0,0 +1,12 @@
+  test:
+    <<: *defaults 
+    steps:
+      - checkout
+      - attach-roro
+      - run: docker-compose build
+      - run: docker-compose up -d
+      - run: docker-compose run backend bundle
+      - run: docker-compose run backend yarn
+      - run: docker-compose run backend bin/rails db:create
+      - run: docker-compose run backend bin/rails db:migrate
+      - run: docker-compose run backend bin/rails test

data/lib/roro/stacks/stories_v1/templates/rails/.circleci/workflows/_build_test_push.yml

@@ -0,0 +1,12 @@
+  build-test-push:
+    jobs:
+      - build:
+          <<: *major_only
+      - test:
+          <<: *major_only
+          requires: 
+            - build
+      - push:
+          <<: *major_only
+          requires: 
+            - build

data/lib/roro/stacks/stories_v1/templates/rails/Dockerfile.greenfield.tt

@@ -0,0 +1,51 @@
+FROM ruby:<%= config[:ruby_version] %>-alpine AS builder
+
+LABEL maintainer="<%= config[:docker_email] %> using RoRo"
+
+# Add basic packages
+RUN apk add --no-cache \
+      build-base \
+      postgresql-dev \
+      git \
+      nodejs \
+      yarn \
+      tzdata \
+      file
+
+## Set APP_HOME and BUNDLE_PATH as using ENV instructions:
+ENV APP_HOME /usr/src/app/
+ENV BUNDLE_PATH /gems
+
+## Create both as directories to make sure they exist:
+RUN mkdir -p ${APP_HOME}
+RUN mkdir ${BUNDLE_PATH}
+
+## Tell Docker to create volumes for our workspace and gems
+## so other containers can access them.
+
+RUN gem install bundler:2.1.4
+
+WORKDIR ${APP_HOME}
+
+## Create a Gemfile with just the Rails gem inside:
+RUN echo -e "source 'https://rubygems.org'\ngem 'rails', '6.1.3.1'" > Gemfile
+
+## Bundle to install rails:
+RUN bundle install
+
+## Use Rails to generate a new app. We'll configure it later.
+RUN bundle exec rails new . \
+      --database=postgresql \ 
+      --skip-bundle \
+      --skip-webpack-install
+RUN bundle --jobs 4
+RUN bundle exec rails webpacker:install
+RUN bundle exec rails yarn:install
+## Tell docker not to create a layer:
+FROM scratch AS export-stage
+
+## Copy the generated files onto the host. Note that because we are in a  
+## new container, we don't have access to the previous ${APP_HOME} 
+## variable and so we must hard code it as our source:
+COPY --from=builder /usr/src/app/ .
+

data/lib/roro/{cli → stacks/stories_v1}/templates/rails/config/database.pg.yml

@@ -2,9 +2,9 @@ default: &default
   adapter: postgresql
   encoding: unicode
   host:     <%= ENV.fetch('DATABASE_HOST') %>
-  username: <%= ENV.fetch('POSTGRES_USER') %>
+  username: <%= ENV.fetch('POSTGRES_USERNAME') %>
   password: <%= ENV.fetch('POSTGRES_PASSWORD') %>
-  database: <%= ENV.fetch('POSTGRES_DB') %>
+  database: <%= ENV.fetch('POSTGRES_DATABASE') %>
   pool: 5
   variables:
     statement_timeout: 5000
@@ -15,6 +15,5 @@ development:
 test:
   <<: *default
 
-
 production:
   <<: *default

data/lib/roro/stacks/stories_v1/templates/rails/database/with_mysql/_service.yml

@@ -0,0 +1,10 @@
+  database:
+    image: mysql:5.7
+    env_file:
+      - roro/containers/database/${RORO_ENV:-development}.smart.env
+      - roro/containers/backend/${RORO_ENV:-development}.smart.env
+    volumes:
+      - db_data:/var/lib/mysql
+    restart: always
+    ports:
+      - '3307:3306'

data/lib/roro/stacks/stories_v1/templates/rails/database/with_postgresql/_service.yml

@@ -0,0 +1,7 @@
+  database:
+    image: postgres
+    env_file:
+      - roro/containers/database/${RORO_ENV:-development}.smart.env
+      - roro/containers/backend/${RORO_ENV:-development}.smart.env
+    volumes:
+      - db_data:/var/lib/postgresql/data

data/lib/roro/{cli → stacks/stories_v1}/templates/rails/docker-compose.yml.tt

@@ -2,7 +2,7 @@ version: '3.2'
 
 services:
 
-  web:
+  app:
     build:
       context: .
       dockerfile: roro/containers/app/Dockerfile
@@ -10,7 +10,6 @@ services:
       - database
       - redis
 
-    command: ["bin/rails", "s", "-b", "0.0.0.0"]
     ports:
       - "3000:3000"
       - "4000:4000"
@@ -22,6 +21,7 @@ services:
       - roro/containers/database/${RORO_ENV:-development}.env
     environment:
       - WEBPACKER_DEV_SERVER_HOST=webpack_dev_server
+    command: ["bin/rails", "s", "-b", "0.0.0.0"]
 
   webpack_dev_server:
     build:
@@ -44,7 +44,7 @@ services:
   redis:
     image: redis
 
-<%= yaml_from_template("rails/database/with_#{config['database_vendor']}/_service.yml") %>
+<%= yaml_from_template("rails/database/with_#{config[:database_vendor]}/_service.yml") %>
 
   system_tests:
     image: selenium/standalone-chrome-debug

data/lib/roro/stacks/stories_v1/templates/rails/dotenv/database.mysql.env.tt

@@ -0,0 +1,6 @@
+MYSQL_DATABASE=<%= config[:main_app_name] + "_" + config[:rails_env] + "_db" %>
+MYSQL_DATABASE_PORT=<%= config[:mysql_database_port] %>
+MYSQL_ROOT_PASSWORD=<%= config[:mysql_root_password] %>
+MYSQL_PASSWORD=<%= config[:mysql_password] %>
+MYSQL_USERNAME=<%= config[:mysql_username] %>
+RAILS_ENV=<%= config[:rails_env] %>

data/lib/roro/stacks/stories_v1/templates/rails/dotenv/database.pg.env.tt

@@ -0,0 +1,4 @@
+POSTGRES_USERNAME=<%= config[:postgres_username] %>
+POSTGRES_PASSWORD=<%= config[:postgres_password] %>  
+POSTGRES_DATABASE=<%= config[:main_app_name] + "_" + config[:rails_env] + "_db" %>
+RAILS_ENV=<%= config[:rails_env] %>

data/lib/roro/stacks/stories_v1/templates/rails/kube.rake.tt

@@ -0,0 +1,114 @@
+# require 'dotenv/tasks'
+
+# Rake.application.options.trace = false
+
+# Dotenv.load('.env.production.cluster')
+
+namespace :kube do
+
+  desc 'Rollout a new deployment'
+  task :deploy do
+    apply "kube/deployment.yml"
+    puts `kubectl rollout restart deployment <%= config[:main_app_name] %>-deployment`
+  end
+
+  desc 'Print useful information aout our Kubernete setup'
+  task :list do
+    kubectl 'get pods --all-namespaces'
+    kubectl 'get services --all-namespaces'
+    kubectl 'get ingresses --all-namespaces'
+  end
+
+  desc 'Apply our Kubernete configurations to our cluster'
+  task :setup do
+  
+    kubectl "apply -f #{Rails.root}/roro/kube/service.yml"
+
+    # # Add our Docker Hub credentials to our cluster
+    # kubectl(%Q{create secret docker-registry regcred \
+    #     --docker-server=#{ENV['DOCKER_REGISTRY_SERVER']} \
+    #     --docker-username=#{ENV['DOCKER_USERNAME']} \
+    #     --docker-password=#{ENV['DOCKER_PASSWORD']} \
+    #     --docker-email=#{ENV['DOCKER_EMAIL']} || true
+    # })
+
+    # # Install our Service Component
+    # apply "kube/service.yml"
+
+    # # Install our Rails app Deployment
+    # apply "kube/deployment.yml"
+
+    # # Installs Nginx Ingress controller
+    # apply "https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/mandatory.yaml"
+
+    # # Add a load balancer
+    # apply "https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud-generic.yaml"
+
+    # # Install our Ingress that will link our load balancer to our service(s)
+    # apply "kube/ingress.yml"
+
+    # # Add the Digital Ocean token to the cluster
+    # apply "kube/secret-digital-ocean.yml"
+
+    # # Install cert-manager
+    # kubectl 'create namespace cert-manager'
+    # apply "https://github.com/jetstack/cert-manager/releases/download/v0.14.0/cert-manager.yaml"
+
+    # # Add our certificate
+    # apply "kube/certificate.yml"
+     
+    # # Add the certificate issuer
+    # apply "kube/cluster-issuer.yml"
+  end
+
+  desc "Set the number of instances to run in the cluster"
+  task :scale, [:count] => [:environment] do |t, args|
+     kubectl "scale deployments/myapp-deployment --replicas #{args[:count]}"
+  end
+
+  desc "Run database migrates the database"
+  task :migrate do
+    apply "kube/job-migrate.yml"
+  end
+
+  desc "Open a session to a pod on the cluster"
+  task :shell do
+    exec "kubectl exec -it #{find_first_pod_name} bash"
+  end
+
+  desc "Tail the log files on production"
+  task :logs do
+    exec 'kubectl logs -f -l app=myapp --all-containers'
+  end
+
+  desc "Runs a command in production"
+  task :run, [:command] => [:environment] do |t, args|
+     kubectl "exec -it #{find_first_pod_name} echo $(#{args[:command]})"
+  end
+
+  desc "Run rails console in production"
+  task :console do
+    system "kubectl exec -it #{find_first_pod_name} bundle exec rails console"
+  end
+
+  desc "Print the environment variables"
+  task :config do
+    system "kubectl exec -it #{find_first_pod_name} printenv | sort"
+  end
+
+  def apply(configuration)
+    if File.file?(configuration)
+      puts %x{envsubst < #{configuration} | kubectl apply -f -}
+    else
+      kubectl "apply -f #{configuration}"
+    end
+  end
+
+  def kubectl(command)
+    print %x{ kubectl #{command} }
+  end
+
+  def find_first_pod_name
+    `kubectl get pods|grep myapp-deployment|awk '{print $1}'|head -n 1`.to_s.strip
+  end
+end

data/lib/roro/stacks/stories_v1/templates/rails/roro/containers/app/Dockerfile.tt

@@ -0,0 +1,34 @@
+## The FROM instruction below builds our first layer using an official image:
+FROM ruby:<%= config[:ruby_version] %>-alpine
+
+LABEL maintainer="<%= config[:docker_email] %> using RoRo"
+
+# Add basic packages
+RUN apk add --no-cache \
+      build-base \
+      postgresql-dev \
+      nodejs \
+      yarn \
+      tzdata \
+      file 
+      
+## Set APP_HOME and BUNDLE_PATH as using ENV instructions:
+ENV APP_HOME /usr/src/app/
+ENV BUNDLE_PATH /gems
+
+## Create both as directories to make sure they exist:
+RUN mkdir -p ${APP_HOME}
+RUN mkdir ${BUNDLE_PATH}
+
+## Tell Docker to create volumes for our workspace and gems
+## so other containers can access them.
+
+RUN gem install bundler:2.1.4
+
+WORKDIR ${APP_HOME}
+
+COPY Gemfile* ./ 
+
+RUN bundle --jobs 4
+COPY . ${APP_HOME}
+

data/lib/roro/stacks/stories_v1/templates/rails/roro/kube/deployment.yml.tt

@@ -0,0 +1,50 @@
+# ./kube/deployment.yml
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: <%= config[:main_app_name] %>-app-deployment
+  labels:
+    app: <%= config[:main_app_name] %>-app
+    tier: app
+spec:
+  replicas: 2
+  minReadySeconds: 5
+  strategy:
+    type: RollingUpdate
+    rollingUpdate:
+      maxSurge: 1
+      maxUnavailable: 1
+  selector:
+    matchLabels:
+      app: <%= config[:main_app_name] %>-app
+      tier: app
+  template:
+    metadata:
+      labels:
+        app: rubytags
+        tier: app
+    spec:
+      imagePullSecrets:
+        - name: docker-registry
+      containers:
+      - name: <%= config[:main_app_name] %>-app
+        image: <%= config[:docker_org] %>/<%= config[:main_app_name] %>-app
+        imagePullPolicy: Always
+        ports:
+        - containerPort: 3000
+        env:
+        - name: RAILS_LOG_TO_STDOUT
+          value: 'true'
+        - name: SECRET_KEY_BASE
+          value: '$SECRET_KEY_BASE'
+        - name: RAILS_ENV
+          value: '$RAILS_ENV'
+        - name: DATABASE_USERNAME
+          value: '$DATABASE_USERNAME'
+        - name: DATABASE_PASSWORD
+          value: '$DATABASE_PASSWORD'
+        - name: DATABASE_HOST
+          value: '$DATABASE_HOST'
+        - name: DATABASE_PORT
+          value: '$DATABASE_PORT'