tpt-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98d683342ba1f15d5e4aa733de08516198e9190c2642c9c50b37ef6c3d0d8821
+  data.tar.gz: c640bd28429845a2ccb0b2ef40594f48543e073f334e2787f6f8e13e5bdd9983
+SHA512:
+  metadata.gz: f7601dd782766cab7efbd7e96439c1b668b7b371e77c9a53e0f4d796adb2fb4bc0b63306e0af9b540cefa1c1d17600a2a9979e54697b40f7c2bfa1fcb709b347
+  data.tar.gz: beceb38da7ec528021393471200330c2a4c59e8759ec64a9914479dc1027521ca1c23c6582bad5fa2d404241bd6f35749dfb43cab904cc2c698fbb234d6ed65b

data/README.md

@@ -0,0 +1,127 @@
+# Tpt::Rails
+
+This library helps integrate Rails projects into TpT infrastructure (e.g. Datadog, Bugsnag, etc).
+
+## Usage
+
+### Adding to your app
+
+**NOTE: The [TpT Rails Template](https://github.com/TeachersPayTeachers/rails-template) will
+automatically do the following for you.**
+
+```sh
+bundle add tpt-rails --git 'git@github.com:TeachersPayTeachers/tpt-rails'
+rails generate tpt_rails:configure
+```
+
+### Configuration
+
+Running `rails generate tpt_rails:configure` will generate `config/initializers/tpt_rails.rb`. You
+can configure this gem and enable optional features in that file.
+
+See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
+
+For Kubernetes configuration:
+```sh
+rails generate tpt_rails:kubernetes
+```
+
+For CI/CD configuration:
+```sh
+rails generate tpt_rails:continuous_integration
+```
+
+### Overview
+
+This gem provides the following features:
+
+- Datadog
+  - Instruments your app for tracing and provides `Tpt::Rails.statsd` for custom metrics
+- Bugsnag/Rollbar
+  - Configures your app to report exceptions and provides `Tpt::Rails.report` for handled errors
+- Health check endpoint
+  - Adds a health check at `/internal/health-check`, including built-in DB and Redis health checks
+- Error test endpoint
+  - Adds an error test at `/internal/error-test` that reports an error and emits a metric
+- Kubernetes/Helm configuration
+- CI/CD configuration
+
+See below for more details.
+
+### Datadog
+
+If you configure `datadog_trace_url` then your project will be automatically instrumented.
+
+If you configure `datadog_statsd_url` then you can also generate custom metrics:
+
+```ruby
+Tpt::Rails.statsd.increment('foo', tags: ['a:b', 'c:d'])
+```
+
+See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
+
+### Error reporting (e.g. Bugsnag/Rollbar)
+
+If you configure `rollbar_access_token` or `bugsnag_api_key` then your project will be automatically
+configured to report unhandled exceptions.
+
+To report handled exceptions:
+
+```ruby
+rescue => e
+  Tpt::Rails.report(e)
+```
+
+See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
+
+### Health check endpoint
+
+Tpt::Rails provides the following endpoint:
+
+/internal/health-check
+
+Two checks are added automatically:
+- An ActiveRecord database check is performed if ActiveRecord is used in the app.
+- A Redis check is performed if Redis is used in the app.
+
+You may add more health checks as follows:
+```ruby
+config.health_check(:foo) { 1 == 1 }
+```
+
+See the documentation for `Tpt::Rails::Config#health_check` in
+[lib/tpt/rails/config.rb](lib/tpt/rails/config.rb) for more details.
+
+### Error test endpoint
+
+Tpt::Rails provides the following endpoint:
+
+/internal/error-test
+
+This endpoint reports an error via `Tpt::Rails.report` and emits a metric to Datadog.
+
+## Developing this Gem
+
+### Running tests
+
+1. Start `docker-compose up` (provides a real Redis instance for tests)
+2. Run `rails test`
+
+### Using your local version of this gem in a local app
+
+Change your Gemfile to:
+
+```ruby
+gem 'tpt-rails', path: '/your/local/path/to/tpt/rails'
+```
+
+### Publishing a new version of this gem
+
+First ensure you have permissions to publish to rubygems.org.
+
+Then execute:
+```sh
+bundle exec gem bump --push --tag --version patch # patch/minor/major/X.X.X
+bundle exec gem release
+```
+

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tpt::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/tpt_rails_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/tpt/rails .css

data/app/assets/stylesheets/tpt/rails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/tpt/rails/application_controller.rb

@@ -0,0 +1,5 @@
+module Tpt::Rails
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/tpt/rails/error_tests_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "tpt/rails/application_controller"
+
+class Tpt::Rails::ErrorTestsController < Tpt::Rails::ApplicationController
+  def index
+    emit_metric
+    report_error
+    render json: { message: "metric emitted and error reported" }
+  end
+
+  private
+
+  def emit_metric
+    Tpt::Rails.statsd.increment("error_test")
+  end
+
+  def report_error
+    raise "just testing"
+  rescue => e
+    Tpt::Rails.report(e)
+  end
+end

data/app/controllers/tpt/rails/health_checks_controller.rb

@@ -0,0 +1,18 @@
+require_dependency "tpt/rails/application_controller"
+
+class Tpt::Rails::HealthChecksController < ApplicationController
+  def index
+    results = Tpt::Rails.config.health_checks.check
+
+    healthy = results.values.all?
+    code = healthy ? 200 : 500
+
+    render(
+      status: code,
+      json: {
+        healthy: healthy,
+        checks: results,
+      },
+    )
+  end
+end

data/app/helpers/tpt/rails/application_helper.rb

@@ -0,0 +1,4 @@
+module Tpt::Rails
+  module ApplicationHelper
+  end
+end

data/app/jobs/tpt/rails/application_job.rb

@@ -0,0 +1,4 @@
+module Tpt::Rails
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/tpt/rails/application_mailer.rb

@@ -0,0 +1,6 @@
+module Tpt::Rails
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/tpt/rails/application_record.rb

@@ -0,0 +1,5 @@
+module Tpt::Rails
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/tpt/rails/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Tpt rails</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "tpt/rails/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Tpt::Rails::Engine.routes.draw do
+  scope 'internal' do
+    get 'health-check', to: 'health_checks#index'
+    get 'error-test', to: 'error_tests#index'
+  end
+end

data/lib/generators/tpt_rails/configuration/configuration_generator.rb

@@ -0,0 +1,10 @@
+class Tpt::Rails::ConfigurationGenerator < ::Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  desc 'Configure the app to use tpt-rails shared functionality'
+
+  def configure
+    route "mount Tpt::Rails::Engine => '/'"
+    template 'config/initializers/tpt_rails.rb'
+  end
+end

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

@@ -0,0 +1,10 @@
+Tpt::Rails.configure do |config|
+  config.app_name = ENV.fetch('APP_NAME')
+  config.app_env = ENV.fetch('APP_ENV')
+  if ENV['DOGSTATSD_URL'].present?
+    config.datadog_statsd_url = ENV.fetch('DOGSTATSD_URL')
+  end
+  if ENV['DATADOG_TRACE_URL'].present?
+    config.datadog_trace_url = ENV.fetch('DATADOG_TRACE_URL')
+  end
+end

data/lib/generators/tpt_rails/continuous_integration/continuous_integration_generator.rb

@@ -0,0 +1,17 @@
+class Tpt::Rails::ContinuousIntegrationGenerator < ::Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def setup_continuous_integration
+    # TODO: should we run tpt cli to generate `test.config.xml`?
+    # TODO: ask nathan about the test/tptcd/tptci files
+    directory('ci')
+
+    say(<<~MESSAGE)
+      …note about running `tpt ci run protect.test.unit` to run tests
+      
+      You need to ask dev tools to create a credential in jenkins. Example ticket:
+      https://teacherspayteachers.atlassian.net/browse/DEVT-710
+    
+    MESSAGE
+  end
+end

data/lib/generators/tpt_rails/continuous_integration/templates/ci/Dockerfile.tt

@@ -0,0 +1,31 @@
+FROM teacherspayteachers/tptci as tptci
+FROM ruby:<%= RUBY_VERSION %>
+
+RUN mkdir -p /app
+WORKDIR /app
+
+RUN curl -sL https://deb.nodesource.com/setup_12.x | bash \
+  && apt-get update && apt-get install -y nodejs && rm -rf /var/lib/apt/lists/* \
+  && curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
+  && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
+  && apt-get update && apt-get install -y yarn && apt-get install -y netcat && rm -rf /var/lib/apt/lists/*
+
+COPY package.json yarn.lock /app/
+RUN yarn install --check-files
+
+ENV RAILS_ENV test
+ENV APP_ENV test
+ENV APP_NAME <%= Tpt::Rails.app_name %>
+
+# GITHUB_TOKEN allows accessing our private tpt-rails gem on Github
+ARG GITHUB_TOKEN
+
+COPY Gemfile /app/Gemfile
+COPY Gemfile.lock /app/Gemfile.lock
+# TODO: Do we need this? Can we move it into a base image?
+RUN gem update bundler
+RUN BUNDLE_GITHUB__COM="${GITHUB_TOKEN}:x-oauth-basic" bundle install
+
+COPY . .
+
+COPY --from=tptci /usr/bin/tptci /usr/bin/tptci

data/lib/generators/tpt_rails/continuous_integration/templates/ci/docker-compose.yaml.tt

@@ -0,0 +1,26 @@
+version: '3'
+services:
+  db:
+    image: mysql:5.7
+    ports:
+      - '3306:3306'
+    environment:
+      MYSQL_ROOT_PASSWORD: ''
+      MYSQL_ALLOW_EMPTY_PASSWORD: '1'
+
+  tests:
+    build:
+      context: ../
+      dockerfile: ci/Dockerfile
+      args:
+        GITHUB_TOKEN: ${GITHUB_TOKEN}
+    links:
+      - db
+    depends_on:
+      - db
+    environment:
+      MYSQL_HOSTNAME: db
+      MYSQL_PORT: 3306
+      RAILS_LOG_TO_STDOUT: '1'
+      DATABASE_URL: 'mysql2://root:@db:3306/<%= Tpt::Rails.app_name %>_test'
+      DISABLE_SPRING: '1'

data/lib/generators/tpt_rails/continuous_integration/templates/ci/tasks/project.test.unit

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+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/continuous_integration/templates/ci/test.Jenkinsfile.tt

@@ -0,0 +1,40 @@
+@Library('tpt-pipeline-library') _
+
+def ci = new tpt.CI(this)
+ci.project = '<%= Tpt::Rails.app_name %>'
+
+pipeline {
+  agent {
+    label 'docker-node'
+  }
+
+  environment {
+    GITHUB_TOKEN = credentials('24caddab-590e-467f-a1d2-1c0c1864d628')
+  }
+
+  stages {
+    stage('Start') {
+      steps {
+        startBuild(ci)
+      }
+    }
+
+    stage('Build') {
+      steps {
+        dockerComposeBuild(ci)
+      }
+    }
+
+    stage('Unit Test') {
+      steps {
+        dockerComposeRun(ci, "tests", './ci/tasks/project.test.unit')
+      }
+    }
+  }
+
+  post {
+    always {
+      finishBuild(ci, currentBuild.currentResult)
+    }
+  }
+}