Use docker-compose to run Solr in CI

Fixes #2195
Fixes #2231
Closes #2256
Supersedes #2256

In this way, we are using docker-compose for development and testing of the Blacklight gem itself, not for downstream purposes such as generation of new Blacklight applications, which will continue to use solr_wrapper.

Author: mjgiarlo

.docker/app/Dockerfile

@@ -1,12 +1,26 @@
-FROM ruby:2.6
-RUN \
-      wget -qO- https://deb.nodesource.com/setup_9.x | bash - && \
-      wget -qO- 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 -qq && \
-      apt-get install -y --force-yes --no-install-recommends && \
-      nodejs yarn build-essential libpq-dev \
-      && apt-get clean
-RUN gem install bundler
+ARG ALPINE_RUBY_VERSION
+
+FROM ruby:${ALPINE_RUBY_VERSION}-alpine
+
+RUN apk add --update --no-cache \
+  bash \
+  build-base \
+  git \
+  libxml2-dev \
+  libxslt-dev \
+  nodejs \
+  sqlite-dev \
+  tzdata
+
 RUN mkdir /app
 WORKDIR /app
+
+RUN gem update --system && \
+  gem install bundler && \
+  bundle config build.nokogiri --use-system-libraries
+
+COPY . .
+
+EXPOSE 3000
+
+CMD [".docker/app/entrypoint.sh"]

.docker/app/entrypoint.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+
+rm -f /app/.internal_test_app/tmp/pids/server.pid
+bundle install
+exec bundle exec rake blacklight:server["-p 3000 -b 0.0.0.0"]

.env

@@ -0,0 +1,5 @@
+ALPINE_RUBY_VERSION=2.6.5
+RAILS_VERSION=5.2.4.1
+SOLR_PORT=8983
+SOLR_URL=http://solr:8983/solr/blacklight-core
+SOLR_VERSION=latest

.travis.yml

@@ -1,10 +1,9 @@
 dist: bionic
+
 addons:
   chrome: stable
-language: ruby
 
-notifications:
-  email: false
+language: ruby
 
 matrix:
   include:
@@ -25,26 +24,19 @@ matrix:
   fast_finish: true
 
 before_install:
-  - docker pull solr:7
-  - docker run -d -p 8983:8983 -v $PWD/lib/generators/blacklight/templates/solr/conf:/myconfig solr:7 solr-create -c blacklight-core -d /myconfig
-  - docker ps -a
   - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - [email protected]
-
-global_env:
-  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
-  - CC_TEST_REPORTER_ID=5042c7358c96b0b926088a4cda3e132fffe7a66ce8047cdb1dc6f0b4b6676b79
-
-jdk: openjdk11
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+    - CC_TEST_REPORTER_ID=5042c7358c96b0b926088a4cda3e132fffe7a66ce8047cdb1dc6f0b4b6676b79
 
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
+
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  - docker-compose build app || travis_terminate 1 # validates application Dockerfile

bin/start.sh

@@ -5,26 +5,27 @@ services:
     build:
       context: .
       dockerfile: .docker/app/Dockerfile
-    stdin_open: true
-    tty: true
+      args:
+        - ALPINE_RUBY_VERSION
     volumes:
       - .:/app
     depends_on:
       - solr
     ports:
       - "3000:3000"
     environment:
-      SOLR_URL: "http://solr:8983/solr/blacklight-core"
-      DEVELOPMENT_ENVIRONMENT: "docker"
-    entrypoint:
-      - /app/bin/start.sh
+      - SOLR_URL # Set via environment variable or use default defined in .env file
+      - RAILS_VERSION # Set via environment variable or use default defined in .env file
 
   solr:
-    image: solr:7
+    environment:
+      - SOLR_PORT # Set via environment variable or use default defined in .env file
+      - SOLR_VERSION # Set via environment variable or use default defined in .env file
+    image: "solr:${SOLR_VERSION}"
     volumes:
       - $PWD/lib/generators/blacklight/templates/solr/conf:/opt/solr/conf
     ports:
-      - "8983:8983"
+      - "${SOLR_PORT}:8983"
     entrypoint:
       - docker-entrypoint.sh
       - solr-precreate

docker-compose.yml

@@ -10,12 +10,26 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
+def with_solr
+  puts "Starting Solr"
+  system "docker-compose up -d solr"
+  yield
+ensure
+  puts "Stopping Solr"
+  system "docker-compose stop solr"
+end
+
 desc "Run test suite"
-task ci: ['blacklight:generate'] do
-  within_test_app do
-    system "RAILS_ENV=test rake blacklight:index:seed"
+task :ci do
+  with_solr do
+    Rake::Task['engine_cart:generate'].invoke
+
+    within_test_app do
+      system "RAILS_ENV=test bin/rake blacklight:index:seed"
+    end
+
+    Rake::Task['blacklight:coverage'].invoke
   end
-  Rake::Task['blacklight:coverage'].invoke
 end
 
 namespace :blacklight do
@@ -25,40 +39,35 @@ namespace :blacklight do
     Rake::Task["spec"].invoke
   end
 
-  desc "Create the test rails app"
-  task generate: ['engine_cart:generate'] do
-  end
-
   namespace :internal do
+    desc 'Index seed data in test ap'
     task seed: ['engine_cart:generate'] do
       within_test_app do
-        system "bundle exec rake blacklight:index:seed"
+        system "bin/rake blacklight:index:seed"
       end
     end
   end
 
   desc 'Run Solr and Blacklight for interactive development'
   task :server, [:rails_server_args] do |_t, args|
-    if File.exist? EngineCart.destination
-      within_test_app do
-        system "bundle update"
-
-        if ENV["DEVELOPMENT_ENVIRONMENT"] == "docker"
-          system "bundle exec rake blacklight:index:seed"
-          system "bundle exec rails s #{args[:rails_server_args]}"
-          next
+    with_solr do
+      if File.exist? EngineCart.destination
+        within_test_app do
+          system "bundle update"
         end
+      else
+        Rake::Task['engine_cart:generate'].invoke
       end
-    else
-      Rake::Task['engine_cart:generate'].invoke
-    end
 
-    SolrWrapper.wrap do |solr|
-      solr.with_collection do
-        Rake::Task['blacklight:internal:seed'].invoke
+      Rake::Task['blacklight:internal:seed'].invoke
 
-        within_test_app do
-          system "bundle exec rails s #{args[:rails_server_args]}"
+      within_test_app do
+        begin
+          puts "Starting Blacklight (Rails server)"
+          system "bin/rails s #{args[:rails_server_args]}"
+        rescue Interrupt
+          # We expect folks to Ctrl-c to stop the server so don't barf at them
+          puts "\nStopping Blacklight (Rails server)"
         end
       end
     end