tpt-rails 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7990c91ca054f067f184b1ba9bb3ddfd43fc21ec0006b1600ed0b5ac54631fa
-  data.tar.gz: d4971b9eb12c19ee4cac5053dcea9260cf6edef742e32a2acda6190bca56744a
+  metadata.gz: 0aac14c9d173af50335042c50b4831a94aae59d754e93ff5c9e7221094516679
+  data.tar.gz: d76804b0ecb5f42a93d62cb502bbfee0c18849b50154b7702e3bfd12be27ba1d
 SHA512:
-  metadata.gz: 5747eccc8946d8d082aa40c7a815b37b38833a4af2bda0c38ab870c03e8a05f09dfc747478155065e253c10b1979aa59d36e91f218abed503466efac62e12c2a
-  data.tar.gz: 36800d28c159f7e3a14e6ab753955dd19d79449bdbb00679544e88920d249d74eab5d460ea991331564d493b85606722f540120d96e61a5d17774e0c3e01280f
+  metadata.gz: 1b11d48d48cccc11b32aeff9fa8500d4414fbbb68235659bf0d6a6059cef79f213c2dcee6e1c86481473879f99f41621e56d017b36ce3d400aba7548c14cbd07
+  data.tar.gz: 5516c6cf9f62916825d8558d82db9b9131cafe295c6cf0a80f81d0d0d8aa83d645cfa92681f51811db9dccf7e2702747ac16cb899dd7b512b631e3a3b0d032ad

data/README.md

@@ -11,7 +11,7 @@ automatically do the following for you.**
 
 ```sh
 bundle add tpt-rails --git 'git@github.com:TeachersPayTeachers/tpt-rails'
-rails generate tpt_rails:configure
+rails generate tpt:rails:configuration
 ```
 
 ### Configuration
@@ -23,12 +23,12 @@ See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
 
 For Kubernetes configuration:
 ```sh
-rails generate tpt_rails:kubernetes
+rails generate tpt:rails:kubernetes
 ```
 
 For CI/CD configuration:
 ```sh
-rails generate tpt_rails:continuous_integration
+rails generate tpt:rails:continuous_integration
 ```
 
 ### Overview

data/lib/generators/tpt/rails/configuration/templates/config/initializers/tpt_rails.rb

@@ -0,0 +1,14 @@
+Tpt::Rails.configure do |config|
+  config.app_name = ENV.fetch('APP_NAME')
+  config.app_env = if ENV['APP_ENV_NAME'].present? && ENV['APP_ENV_NAME'] != 'default'
+    "#{ENV.fetch('APP_ENV')}-#{ENV.fetch('APP_ENV_NAME')}"
+  else
+    ENV.fetch('APP_ENV')
+  end
+
+  config.rollbar_access_token = ''
+  config.rollbar_enabled = ENV["ROLLBAR_ENABLED"] == '1'
+
+  config.datadog_statsd_url = ENV["DOGSTATSD_URL"].presence
+  config.datadog_trace_url = ENV["DATADOG_TRACE_URL"].presence
+end

data/lib/generators/tpt/rails/continuous_integration/continuous_integration_generator.rb

@@ -0,0 +1,7 @@
+class Tpt::Rails::ContinuousIntegrationGenerator < ::Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def setup_continuous_integration
+    directory('ci')
+  end
+end

data/lib/generators/tpt/rails/continuous_integration/templates/ci/Dockerfile.tt

@@ -0,0 +1,42 @@
+FROM teacherspayteachers/tptci as tptci
+FROM ruby:<%= RUBY_VERSION %>-alpine
+
+ENV LANG C.UTF-8
+
+RUN \
+  apk add --no-cache \
+    # temporarily adding git to allow using gems from git sources
+    git \
+    # bash is nice to have when we need a shell into a container
+    bash \
+    # tzdata is required by rails to avoid "tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile"
+    tzdata \
+    # busybox is useful utilities when we need a shell into a container
+    busybox \
+    # curl is useful when we need a shell into a container
+    curl \
+    # screen helps with long-running tasks in one-off pods
+    screen \
+    # netcat is for detecting when the DB is ready during CI testing
+    netcat-openbsd \
+    # build-base is required for mysql2 and pg gems
+    build-base \
+    # mariadb-dev is required for mysql2
+    mariadb-dev
+
+RUN gem install bundler -v '~> 2.2'
+
+RUN bundle config --global ignore_messages true
+
+RUN mkdir /app
+WORKDIR /app
+
+ENV RAILS_ENV=test APP_ENV=test APP_NAME=<%= Tpt::Rails.app_name %>
+
+COPY Gemfile Gemfile.lock .ruby-version /app/
+
+RUN bundle install --jobs=4 --retry=3
+
+COPY . .
+
+COPY --from=tptci /usr/bin/tptci /usr/bin/tptci

data/lib/generators/{tpt_rails → tpt/rails}/continuous_integration/templates/ci/docker-compose.yaml.tt

@@ -3,7 +3,7 @@ services:
   db:
     image: mysql:5.7
     ports:
-      - '3306:3306'
+      - '3306'
     environment:
       MYSQL_ROOT_PASSWORD: ''
       MYSQL_ALLOW_EMPTY_PASSWORD: '1'
@@ -12,8 +12,6 @@ services:
     build:
       context: ../
       dockerfile: ci/Dockerfile
-      args:
-        GITHUB_TOKEN: ${GITHUB_TOKEN}
     links:
       - db
     depends_on:

data/lib/generators/tpt/rails/continuous_integration/templates/ci/tasks/project.test.unit.tt

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+if [ "$CI_PLATFORM" = "brigade" ]; then
+  export RAILS_LOG_TO_STDOUT='1'
+  export RAILS_ENV='test'
+  export DISABLE_SPRING='1'
+
+  MYSQL_HOSTNAME="$(tptci -q print-app-name <%= Tpt::Rails.app_name %> -b mysql)"
+  MYSQL_PORT=3306
+  export DATABASE_URL="mysql2://root:123456@${MYSQL_HOSTNAME}:${MYSQL_PORT}/<%= Tpt::Rails.app_name %>_test"
+fi
+
+until nc -z -v ${MYSQL_HOSTNAME} ${MYSQL_PORT}
+do
+  echo "Waiting for database connection..."
+  sleep 5
+done
+
+exec bin/rails db:prepare test
+
+# Uncomment to run system tests
+# exec bin/rails test:system

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/kubernetes_generator.rb

@@ -15,18 +15,15 @@ class Tpt::Rails::KubernetesGenerator < ::Rails::Generators::Base
     check_dependencies
 
     secrets_name = "#{Tpt::Rails.app_name}-secrets"
+    secrets_key = "secret-key-base"
+    secrets_value = SecureRandom.alphanumeric(32).downcase
 
-    tpt_yaml = generate_tpt_yaml
-    team_name = tpt_yaml.fetch('owner')
-    app_type = tpt_yaml.fetch('target')
+    team_name = ask("What's your GitHub team name? Something like `core-services`").strip
+    app_type = "internal"
 
     tpt_config = get_tpt_config
     tpt_user_alias = tpt_config.fetch('user.alias')
 
-    default_email = get_default_email_address
-    email = ask("What's the maintainer email address? (#{default_email})").strip
-    email = email.presence || default_email || 'FIXME'
-
     template 'Dockerfile'
     template 'entrypoint.sh'
     template '.dockerignore'
@@ -35,7 +32,7 @@ class Tpt::Rails::KubernetesGenerator < ::Rails::Generators::Base
       'kubernetes',
       team_name: team_name,
       secrets_name: secrets_name,
-      maintainer_email: email,
+      secrets_key: secrets_key,
       app_type: app_type,
     )
 
@@ -43,8 +40,9 @@ class Tpt::Rails::KubernetesGenerator < ::Rails::Generators::Base
       run('helm dependency update', abort_on_failure: true)
     end
 
-    add_kube_secret(secrets_name)
+    add_kube_secret(secrets_name, secrets_key, secrets_value)
 
+    # TODO: move the below instruction to a wiki page
     say(<<~MESSAGE)
 
       ********************************************************************************
@@ -56,16 +54,12 @@ class Tpt::Rails::KubernetesGenerator < ::Rails::Generators::Base
       !
       ! 1. Review and commit these changes
       ! 2. Push your changes up to a Github repository
-      ! 3. Run `tpt project check`
+      ! 3. Follow the docker instructions on
+      !     https://teacherspayteachers.atlassian.net/wiki/spaces/SER/pages/1521090593/Getting+started+Create+a+new+serverless+service#Build-and-push-your-project-to-DockerHub
       ! 4. Deploy to an ODE with `tpt project push`
-      ! 5. Give "Read-only" access to the Docker Hub "readonly" user:
-      !   - Go to https://hub.docker.com/repository/docker/teacherspayteachers/#{Tpt::Rails.app_name}/permissions
-      !   - Choose "readonly" in the "Team" dropdown box
-      !   - Choose "Read-only" in the "Permission" box
-      !   - Click the "+" button on the right-hand side
-      ! 6. Monitor the status of your ODE deploy with:
+      ! 5. Monitor the status of your ODE deploy with:
       !      kubectl get pods --namespace #{tpt_user_alias} | grep #{Tpt::Rails.app_name}
-      ! 7. When your ODE is ready you can visit it here:
+      ! 6. When your ODE is ready you can visit it here:
       !      http://#{Tpt::Rails.app_name}--#{tpt_user_alias}.ode.tptpm.info/#{Tpt::Rails::Engine.instance.routes.url_helpers.health_check_path}
       !
       ! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -104,50 +98,21 @@ class Tpt::Rails::KubernetesGenerator < ::Rails::Generators::Base
     Tpt::Rails.app_name =~ VALID_APP_NAME
   end
 
-  def generate_tpt_yaml
-    # TODO: Add an options to `tpt project init` that allows passing in these values
-    say(<<~TEXT)
-
-      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-      ! IMPORTANT !
-      ! In the prompt below, please enter "#{Tpt::Rails.app_name}" for the "project name"
-      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-    TEXT
-
-    run('tpt project init --force', abort_on_failure: true)
-
-    YAML.load(run('cat tpt.yaml', capture: true, abort_on_failure: true))
-  end
-
   def get_tpt_config
     conf = run('tpt config get', capture: true, abort_on_failure: true)
     YAML.load(conf)
+  rescue
+    say("Failed to get tpt config")
+    raise
   end
 
-  def get_default_email_address
-    run('git config user.email', capture: true, abort_on_failure: false)&.strip.presence
-  end
-
-  def add_kube_secret(secrets_name)
-    secret = run('cat config/master.key', capture: true, abort_on_failure: true).strip
+  def add_kube_secret(secrets_name, secrets_key, secrets_value)
     key_exists = run("kubectl get secret #{secrets_name} --context='#{ODE_KUBE_CONTEXT}' >/dev/null 2>&1", abort_on_failure: false)
 
-    if key_exists
-      say "Kube secret #{secrets_name} already exists. Updating it…"
-      ENV['KUBE_GENERATOR_RAILS_MASTER_KEY'] = Base64.strict_encode64(secret)
-      run(
-        <<~CMD,
-          kubectl get secret #{secrets_name} --context=#{ODE_KUBE_CONTEXT} --output=json \
-          | jq --arg key $KUBE_GENERATOR_RAILS_MASTER_KEY '.data["rails-master-key"]=$key' \
-          | kubectl apply --context=#{ODE_KUBE_CONTEXT} -f -
-        CMD
-        abort_on_failure: true,
-      )
-    else
+    if !key_exists
       say "Kube secret #{secrets_name} not found. Creating it…"
       run(
-        "kubectl create secret generic #{secrets_name} --from-literal='rails-master-key=#{secret}' --context='#{ODE_KUBE_CONTEXT}'",
+        "kubectl create secret generic #{secrets_name} --from-literal='#{secrets_key}=#{secrets_value}' --context='#{ODE_KUBE_CONTEXT}'",
         abort_on_failure: true,
       )
     end

data/lib/generators/tpt/rails/kubernetes/templates/Dockerfile.tt

@@ -0,0 +1,56 @@
+FROM ruby:<%= RUBY_VERSION %>-alpine
+
+ENV LANG C.UTF-8
+
+RUN \
+  apk add --no-cache \
+    # temporarily adding git to allow using gems from git sources
+    git \
+    # bash is nice to have when we need a shell into a container
+    bash \
+    # tzdata is required by rails to avoid "tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile"
+    tzdata \
+    # busybox is useful utilities when we need a shell into a container
+    busybox \
+    # curl is useful when we need a shell into a container
+    curl \
+    # screen helps with long-running tasks in one-off pods
+    screen \
+    # netcat is for detecting when the DB is ready during Jenkins testing
+    netcat-openbsd \
+    # build-base is required for mysql2 and pg gems
+    build-base \
+    # mariadb-dev is required for mysql2
+    mariadb-dev \
+    # mariadb-client allows us to perform manual mysql queries via console when needed
+    mariadb-client
+
+RUN gem install bundler -v '~> 2.2'
+
+RUN bundle config --global ignore_messages true
+
+RUN mkdir /app
+WORKDIR /app
+
+# Set production env for asset compilation
+ARG RAILS_ENV=production
+ARG APP_ENV=production
+ARG APP_NAME=<%= Tpt::Rails.app_name %>
+
+# Add a script to be executed every time the container starts.
+COPY entrypoint.sh /usr/bin/
+
+COPY Gemfile Gemfile.lock .ruby-version ./
+RUN \
+  bundle config without 'development test' && \
+  bundle install --jobs=4 --retry=3
+
+COPY . .
+
+# TODO: Delete this?
+ENTRYPOINT ["entrypoint.sh"]
+CMD ["rails", "server", "-b", "0.0.0.0"]
+EXPOSE 3000
+
+ARG TPT_RELEASE_VERSION
+ENV TPT_RELEASE_VERSION=$TPT_RELEASE_VERSION

data/lib/generators/tpt/rails/kubernetes/templates/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+if [ -f /app/tmp/pids/server.pid ]; then
+  rm /app/tmp/pids/server.pid
+fi
+
+echo "Starting server"
+exec "$@"

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/Chart.yaml.tt

@@ -12,5 +12,5 @@ keywords: [odev2, rails, service-template, '<%= Tpt::Rails.app_name %>', '<%= co
 home: https://www.teacherspayteachers.com
 icon: https://static1.teacherspayteachers.com/tpt-frontend/releases/production/current/a24f03b12028dbc93cf182318e6993e5.svg
 sources: ['https://github.com/TeachersPayTeachers/<%= Tpt::Rails.app_name  %>']
-maintainers: [{name: '<%= config.fetch(:team_name) %>', email: '<%= config.fetch(:maintainer_email) %>'}]
+maintainers: [{name: '<%= config.fetch(:team_name) %>', email: '<%= config.fetch(:team_name) %>@teacherspayteachers.com'}]
 engine: gotpl # yaml parsing engine, just leave this alone

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/README.md

@@ -16,8 +16,12 @@ There are a couple files that constitute a Chart. Here is an overview:
 └── kubernetes
     └── helm
         ├── charts
-        │   ├── copy-secrets-1.1.5.tgz
+        │   ├── db-migrate-0.2.2.tgz
+        │   ├── mysql-1.6.9.tgz
         ├── templates
+        │   ├── hooks
+        │   │   ├── db-prepare.yaml
+        │   ├── _env.yaml
         │   ├── _helpers.tpl
         │   ├── autoscaler.yaml
         │   ├── deployment.yaml
@@ -28,7 +32,7 @@ There are a couple files that constitute a Chart. Here is an overview:
         ├── README.md
         ├── requirements.lock
         ├── requirements.yaml
-        ├── values.dev.yaml
+        ├── values.prod.yaml
         ├── values.staging.yaml
         └── values.yaml
 ```

data/lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/requirements.yaml.tt

@@ -0,0 +1,9 @@
+dependencies:
+  - name: mysql
+    version: 1.6.9
+    repository: "@stable"
+    condition: mysql.enabled
+  - name: db-migrate
+    version: 0.2.2
+    repository: https://chartmuseum.tptpm.info
+    condition: db-migrate.enabled

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/templates/_helpers.tpl.tt

@@ -44,7 +44,11 @@ Get service.
 {{- if eq .service.useIngress true -}}
 {{- printf "%s://%s-%s:%v/%s" .service.protocol .service.hostName .domain .service.port $trimPath -}}
 {{- else -}}
+{{- if or (eq .env "staging") (eq .env "production") -}}
 {{- printf "%s://%s:%v/%s" .service.protocol .service.hostName .service.port $trimPath -}}
+{{- else -}}
+{{- printf "%s://%s--%s:%v/%s" .service.protocol .service.hostName .namespace .service.port $trimPath -}}
+{{- end -}}
 {{- end -}}
 {{- end -}}
 

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/templates/deployment.yaml.tt

@@ -15,6 +15,8 @@ metadata:
     tpt/owner: {{ .Values.annotations.owner }}
     tpt/creator: {{ .Values.annotations.creator | default "UNKNOWN" | quote }}
     tpt/release: "{{ .Release.Name }}"
+    tpt/costEnv: {{ .Values.annotations.costEnv | quote }}
+    tpt/costCategory: {{ .Values.annotations.costCategory | quote }}
 spec:
   strategy:
     type: RollingUpdate
@@ -23,7 +25,6 @@ spec:
   selector:
     matchLabels:
       app: {{ template "<%= Tpt::Rails.app_name %>.fullname" . }}
-  replicas: {{ .Values.replicas }}
   # Max number of replicat sets to retain.
   # Sets exceeding this limit will get deleted
   revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
@@ -38,7 +39,7 @@ spec:
         tpt/creator: {{ .Values.annotations.creator | default "UNKNOWN" | quote }}
       annotations:
         buildID: "{{ .Values.buildID }}"
-        sidecar.istio.io/inject: "true"
+        sidecar.istio.io/inject: "false"
     spec:
       # Specifies where our Kube secrets are coming from
       imagePullSecrets:

data/lib/generators/{tpt_rails/kubernetes/templates/kubernetes/helm/templates/hooks/db-migrate.yaml.tt → tpt/rails/kubernetes/templates/kubernetes/helm/templates/hooks/db-prepare.yaml.tt}

@@ -1,8 +1,8 @@
-{{- if .Values.migrateCommand -}}
+{{- if .Values.dbPrepare.enabled }}
 apiVersion: batch/v1
 kind: Job # runs once and then stops
 metadata:
-  name: {{ template "<%= Tpt::Rails.app_name %>.fullname" . }}-db-migrate
+  name: {{ template "<%= Tpt::Rails.app_name %>.fullname" . }}-db-prepare
   labels:
     app: {{ template "<%= Tpt::Rails.app_name %>.name" . }}
     chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
@@ -12,6 +12,8 @@ metadata:
     tpt/owner: {{ .Values.annotations.owner }}
     tpt/creator: {{ .Values.annotations.creator | default "UNKNOWN" | quote }}
     tpt/release: "{{ .Release.Name }}"
+    tpt/costEnv: {{ .Values.annotations.costEnv | quote }}
+    tpt/costCategory: {{ .Values.annotations.costCategory | quote }}
   annotations:
     # post-install: after initial creation of stack, pre-upgrade: before deploying new code
     "helm.sh/hook": "post-install,pre-upgrade"
@@ -42,7 +44,7 @@ spec:
         imagePullPolicy: {{ .Values.image.pullPolicy | quote }}
         command: ["/bin/sh"]
         # This is what causes a different command to be run for this job
-        args: ["-c", "{{ .Values.migrateCommand }}"]
+        args: ["-c", "{{ .Values.dbPrepare.command }}"]
         # Specifies provisioning requests & limits (memory and CPU)
         resources:
           limits:
@@ -53,6 +55,7 @@ spec:
             cpu: {{ .Values.resources.requests.cpu }}
         env:
           {{- include "env" . | indent 10 }}
+          {{- include "<%= Tpt::Rails.app_name %>.services" . | nindent 10 }}
           {{- if .Values.secrets }}
           {{ toYaml .Values.secrets | trim | nindent 10 }}
           {{- end }}