Fix image builds and update image

Includes: * Return errors as JSON * Convert controller specs to request specs to catch OpenAPI problems * Switch from sqlite to postgres for the underlying database * Spin up postgres in CI * Add .dockerignore file to keep images svelte * Update Dockerfile * Update README * Re-generate binstubs and add puma binstub * Add docker-compose configuration with web and db services
sul-dlss · Apr 9, 2020 · 47fb476 · 47fb476
1 parent ab28d7d
commit 47fb476
Show file tree

Hide file tree

Showing 19 changed files with 554 additions and 153 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -18,8 +18,16 @@ jobs:
           BUNDLE_JOBS: 3
           BUNDLE_RETRY: 3
           BUNDLE_PATH: vendor/bundle
+          PGHOST: 127.0.0.1
+          PGUSER: circleci-demo-ruby
+          PGPASSWORD: sekret
           RAILS_ENV: test
           NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+      - image: circleci/postgres:11
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: suri
+          POSTGRES_PASSWORD: sekret
 
     working_directory: ~/repo
 
@@ -47,25 +55,18 @@ jobs:
           name: Which bundler?
           command: bundle -v
 
-      - restore_cache:
-          keys:
-            - suri-rails-dependencies-{{ checksum "Gemfile.lock" }}
-            # fallback to using the latest cache if no exact match is found
-            - suri-rails-dependencies-
-
       - run:
           name: Install dependencies
           command: bundle check || bundle install
 
-      - save_cache:
-          key: dor-services-app-bundle-v2-{{ checksum "Gemfile.lock" }}
-          paths:
-            - vendor/bundle
-
       - run:
           name: Run code linter & style checker
           command: bundle exec rubocop
 
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+
       - run:
           name: Set up database
           command: bin/rails db:test:prepare
@@ -88,51 +89,52 @@ jobs:
   build-image:
     executor: docker-publisher
     steps:
-    - checkout
-    - setup_remote_docker
-    - run:
-        name: Build Docker image
-        command: |
-          docker build -t $IMAGE_NAME:latest .
-    - run:
-        name: Archive Docker image
-        command: |
-          docker save -o app_image.tar $IMAGE_NAME
-    - persist_to_workspace:
-        root: .
-        paths:
-        - ./app_image.tar
+      - checkout
+      - setup_remote_docker
+      - run:
+          name: Build Docker image
+          command: |
+            docker build -t $IMAGE_NAME:latest .
+      - run:
+          name: Archive Docker image
+          command: |
+            docker save -o app_image.tar $IMAGE_NAME
+      - persist_to_workspace:
+          root: .
+          paths:
+            - ./app_image.tar
   publish-latest:
     executor: docker-publisher
     steps:
-    - attach_workspace:
-        at: /tmp/workspace
-    - setup_remote_docker
-    - run:
-        name: Load archived Docker image
-        command: |
-          docker load -i /tmp/workspace/app_image.tar
-    - run:
-        name: Publish Docker Image to Docker Hub
-        command: |
-          echo "$DOCKER_PASS" | docker login -u "$DOCKER_USER" --password-stdin
-          docker push $IMAGE_NAME:latest
+      - attach_workspace:
+          at: /tmp/workspace
+      - setup_remote_docker
+      - run:
+          name: Load archived Docker image
+          command: |
+            docker load -i /tmp/workspace/app_image.tar
+      - run:
+          name: Publish Docker Image to Docker Hub
+          command: |
+            echo "$DOCKER_PASS" | docker login -u "$DOCKER_USER" --password-stdin
+            docker push $IMAGE_NAME:latest
   publish-tag:
     executor: docker-publisher
     steps:
-    - attach_workspace:
-        at: /tmp/workspace
-    - setup_remote_docker
-    - run:
-        name: Load archived Docker image
-        command: |
-          docker load -i /tmp/workspace/app_image.tar
-    - run:
-        name: Publish Docker Image to Docker Hub
-        command: |
-          echo "$DOCKER_PASS" | docker login -u "$DOCKER_USER" --password-stdin
-          docker tag $IMAGE_NAME:latest $IMAGE_NAME:$CIRCLE_TAG
-          docker push $IMAGE_NAME:$CIRCLE_TAG
+      - attach_workspace:
+          at: /tmp/workspace
+      - setup_remote_docker
+      - run:
+          name: Load archived Docker image
+          command: |
+            docker load -i /tmp/workspace/app_image.tar
+      - run:
+          name: Publish Docker Image to Docker Hub
+          command: |
+            echo "$DOCKER_PASS" | docker login -u "$DOCKER_USER" --password-stdin
+            docker tag $IMAGE_NAME:latest $IMAGE_NAME:$CIRCLE_TAG
+            docker push $IMAGE_NAME:$CIRCLE_TAG
+
 workflows:
   version: 2
 
@@ -148,7 +150,7 @@ workflows:
             only: master
     - publish-latest:
         requires:
-        - build-image
+          - build-image
         filters:
           branches:
             only: master
@@ -162,7 +164,7 @@ workflows:
             ignore: /.*/
     - publish-tag:
         requires:
-        - build-image
+          - build-image
         filters:
           tags:
             only: /^[0-9]+\.[0-9]+\.[0-9]+/

diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,8 @@
+.git
+.dockerignore
+.byebug_history
+log
+tmp
+coverage
+# Required for puma to have a place to put the pid file
+!tmp/pids/.keep
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -15,13 +15,36 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Metrics/MethodLength:
+  Exclude:
+    - 'bin/bundle'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'bin/bundle'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'bin/bundle'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'bin/bundle'
+
+Layout/LineLength:
+  Exclude:
+    - 'bin/bundle'
+
 Style/MixinUsage:
   Exclude:
     - 'bin/**/*'
 
 RSpec/MultipleExpectations:
   Max: 5
 
+RSpec/ExampleLength:
+  Enabled: false
+
 Style/HashEachMethods:
   Enabled: true
 

diff --git a/Dockerfile b/Dockerfile
@@ -1,19 +1,27 @@
-FROM ruby:2.7.0-alpine
+FROM ruby:2.7.1-alpine
 
+LABEL maintainer="Stanford Libraries Infrastructure Team <[email protected]>"
 
-RUN apk update && apk add build-base sqlite-dev tzdata git
+RUN apk add --update --no-cache \
+  build-base \
+  git \
+  postgresql-dev \
+  postgresql-client \
+  libxml2-dev \
+  libxslt-dev \
+  tzdata
 
 RUN mkdir /app
 WORKDIR /app
 
-COPY Gemfile Gemfile.lock ./
-RUN gem install bundler -v 2.0.2
-RUN bundle install
+RUN gem update --system && \
+  gem install bundler && \
+  bundle config build.nokogiri --use-system-libraries
 
-COPY . .
+COPY Gemfile Gemfile.lock ./
 
-RUN bundle exec rails db:setup
+RUN bundle config set without 'production' && bundle install
 
-LABEL maintainer="Justin Coyne <[email protected]>"
+COPY . .
 
-CMD puma -C config/puma.rb
+CMD ["./docker/invoke.sh"]
diff --git a/Gemfile b/Gemfile
@@ -20,9 +20,7 @@ group :development, :test do
   gem 'rubocop-performance'
   gem 'rubocop-rails'
   gem 'rubocop-rspec'
-  # Use sqlite3 as the database for Active Record
   gem 'simplecov', '~> 0.17.1' # 0.18 breaks reporting https://github.com/codeclimate/test-reporter/issues/418
-  gem 'sqlite3', '~> 1.4'
 end
 
 group :development do

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -233,7 +233,6 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
     sshkit (1.21.0)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
@@ -273,7 +272,6 @@ DEPENDENCIES
   simplecov (~> 0.17.1)
   spring
   spring-watcher-listen (~> 2.0.0)
-  sqlite3 (~> 1.4)
 
 BUNDLED WITH
    2.1.4
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ NOTE: This is currently used for running specs; we still use https://github.com/
 
 Clone the repository
 
-    $ git clone [email protected]:sul-dlss/suri_rails.git
+    $ git clone [email protected]:sul-dlss/suri-rails.git
 
 Change directories into the app and install dependencies
 
@@ -32,27 +32,35 @@ Start the development server
 
 ## Testing
 
+First, ensure the database container is spun up:
+
+    $ docker-compose up db # use -d to daemonize/run in background
+
+And if you haven't yet prepared the test database, run:
+
+    $ bin/rails db:setup
+
 The test suite (with RuboCop style enforcement) will be run with the default rake task (also run on CI).
 
-    $ rake
+    $ bin/rake
 
 The specs can be run without RuboCop enforcement
 
-    $ rake spec
+    $ bin/rake spec
 
 The RuboCop style enforcement can be run without running the tests
 
-    $ rake rubocop
+    $ bin/rake rubocop
 
 ## Building for Docker
 
-```shell
-$ docker build -t suldlss/suri-rails:latest .
-```
+Spin up the application and its database:
+
+    $ docker-compose up --build
+
+## Updating Docker Image
 
-Then run as:
-```shell
-$ docker run -d -p 127.0.0.1:3002:3000 suldlss/suri-rails:latest
-```
+Note that CI is configured to automatically update the image hosted on DockerHub on every commit to `master`. If you want to build and push an image manually, run:
 
-Note that CI is configured to automatically update the image hosted on DockerHub on every commit to `master`.
+    $ docker build -t suldlss/suri-rails:latest .
+    $ docker push suldlss/suri-rails:latest
diff --git a/app/controllers/identifiers_controller.rb b/app/controllers/identifiers_controller.rb
@@ -2,29 +2,49 @@
 
 class IdentifiersController < ApplicationController
   # GET /identifiers
-  # GET /identifiers.json
   def index
     @identifiers = Identifier.all
 
     render json: @identifiers
   end
 
   # GET /identifiers/1
-  # GET /identifiers/1.json
   def show
-    @identifier = Identifier.find_by(identifier: params[:id])
+    @identifier = Identifier.find_by!(identifier: params[:id])
     render json: @identifier
+  rescue ActiveRecord::RecordNotFound
+    render build_error("Identifier not found: #{params[:id]}", :not_found)
   end
 
   # POST /identifiers
-  # POST /identifiers.json
   def create
     @identifier = Identifier.mint
 
     if @identifier
       render plain: @identifier.identifier, status: :created, location: @identifier
     else
-      render json: { error: 'Unable to mint a druid' }, status: :internal_server_error
+      render build_error('Unable to mint a druid', :internal_server_error)
     end
   end
+
+  private
+
+  # rubocop:disable Metrics/MethodLength
+  # JSON-API error response
+  def build_error(msg, status)
+    {
+      json: {
+        errors: [
+          {
+            "status": Rack::Utils::SYMBOL_TO_STATUS_CODE[status].to_s,
+            "title": msg,
+            "detail": msg
+          }
+        ]
+      },
+      content_type: 'application/vnd.api+json',
+      status: status
+    }
+  end
+  # rubocop:enable Metrics/MethodLength
 end