Dockerization

.github/workflows/ci.yml

@@ -38,10 +38,6 @@ jobs:
       matrix:
         ruby-version: ['2.7.5']
         experimental: [false]
-        include:
-          - ruby-version: 3.0.3
-            experimental: true
-
     steps:
     - name: Pin chrome
       uses: abhi1693/[email protected]
@@ -63,7 +59,7 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Update rubygems
       run: |
-        gem update --system
+        gem install rubygems-update -v 3.4.22
         gem install bundler:2.3.15
 
     - name: Set up JDK 1.8
@@ -102,7 +98,7 @@ jobs:
     - name: Setup hyrax test environment
       run: |
         bundle exec rake hydra:test_server &
-        sleep 150
+        sleep 180
 #    - name: Rubbocop
 #      run: |
 #        bundle exec rubocop

.gitignore

@@ -46,3 +46,7 @@ config/java.yml
 # Spring stuff
 bin/rspec
 bin/spring
+
+# env files
+.env
+coverage/

Dockerfile

@@ -0,0 +1,47 @@
+FROM ruby:2.7.5
+
+ARG RAILS_ENV
+ARG SECRET_KEY_BASE
+
+# Necessary for bundler to operate properly
+ENV LANG C.UTF-8
+ENV LC_ALL C.UTF-8
+
+# add nodejs and yarn dependencies for the frontend
+# RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - && \
+#  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
+
+# --allow-unauthenticated needed for yarn package
+RUN apt-get update && apt-get upgrade -y && \
+  apt-get install --no-install-recommends -y ca-certificates nodejs \
+  build-essential libpq-dev libreoffice unzip ghostscript vim \
+  ffmpeg \
+  clamav-freshclam clamav-daemon libclamav-dev \
+  libqt5webkit5-dev xvfb xauth default-jre-headless --fix-missing --allow-unauthenticated
+
+RUN apt-get install chromium -y
+
+# Increase stack size limit to help working with large works
+ENV RUBY_THREAD_MACHINE_STACK_SIZE 8388608
+
+RUN gem install rubygems-update -v 3.4.22
+
+RUN mkdir /data
+WORKDIR /data
+
+# Pre-install gems so we aren't reinstalling all the gems when literally any
+# filesystem change happens
+ADD Gemfile /data
+ADD Gemfile.lock /data
+RUN mkdir /data/build
+ADD ./build/install_gems.sh /data/build
+RUN ./build/install_gems.sh
+RUN mkdir /data/pdfs
+
+
+# Add the application code
+ADD . /data
+
+# install node dependencies, after there are some included
+#RUN yarn install

Gemfile

@@ -15,8 +15,7 @@ gem 'puma', '~> 4.3'
 gem 'sass-rails', '~> 5.0'
 # Use Uglifier as compressor for JavaScript assets
 gem 'uglifier', '>= 1.3.0'
-# See https://github.com/rails/execjs#readme for more supported runtimes
-gem 'therubyracer', platforms: :ruby
+
 # Use CoffeeScript for .coffee assets and views
 gem 'coffee-rails', '~> 4.2'
 # Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
@@ -71,6 +70,7 @@ group :test do
   gem 'ffaker'
   gem 'ladle'
   gem 'capybara', '>= 2.15'
+  gem 'capybara-screenshot'
   gem 'selenium-webdriver'
   gem 'webdrivers', '~> 4.0', require: false
 end

Gemfile.lock

@@ -164,6 +164,9 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
+    capybara-screenshot (1.0.26)
+      capybara (>= 1.0, < 4)
+      launchy
     carrierwave (1.3.2)
       activemodel (>= 4.0.0)
       activesupport (>= 4.0.0)
@@ -486,6 +489,8 @@ GEM
       kaminari (~> 1.0)
     ladle (1.0.1)
       open4 (~> 1.0)
+    launchy (2.5.2)
+      addressable (~> 2.8)
     ld-patch (3.1.2)
       ebnf (~> 2.1)
       rdf (~> 3.1)
@@ -508,7 +513,6 @@ GEM
       rdf (~> 3.0)
     legato (0.7.0)
       multi_json
-    libv8 (3.16.14.19)
     link_header (0.0.8)
     linkeddata (3.1.1)
       equivalent-xml (~> 0.6)
@@ -711,7 +715,6 @@ GEM
       redis (>= 3.0.4)
     redlock (1.2.1)
       redis (>= 3.0.0, < 5.0)
-    ref (2.0.0)
     regexp_parser (2.0.3)
     representable (3.0.4)
       declarative (< 0.1.0)
@@ -845,9 +848,6 @@ GEM
     sxp (1.1.0)
       rdf (~> 3.1)
     temple (0.8.2)
-    therubyracer (0.12.3)
-      libv8 (~> 3.16.14.15)
-      ref
     thor (1.2.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
@@ -894,6 +894,7 @@ DEPENDENCIES
   bootstrap-sass (~> 3.0)
   byebug
   capybara (>= 2.15)
+  capybara-screenshot
   coffee-rails (~> 4.2)
   devise
   devise-guests (~> 0.6)
@@ -924,7 +925,6 @@ DEPENDENCIES
   simplecov-lcov (~> 0.8.0)
   solr_wrapper (~> 2.1.0)
   sqlite3 (~> 1.3.6)
-  therubyracer
   tufts-curation!
   turbolinks (~> 5)
   twitter-typeahead-rails (= 0.11.1.pre.corejavascript)

README.md

@@ -1,24 +1,20 @@
-# README
+# Trove
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+## About
 
-Things you may want to cover:
+Collections in Trove are available for use by Tufts University faculty and students, for teaching and research purposes. Collections will include images selected by faculty for teaching Art History courses. Faculty and students can create personal collections of images selected from those available in Trove.
 
-* Ruby version
 
-* System dependencies
+## Running Test Locally
 
-* Configuration
+* MIRA test docker environment should be running already
 
-* Database creation
 
-* Database initialization
+```
+docker-compose up test
+docker exec -it trove_test_1 /bin/bash
+xvfb-run -a bundle exec rake spec SPEC_OPTS="--tag ~noci_local"
 
-* How to run the test suite
+```
 
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+There are two testing tags, noci and noci_local some tests aren't working in the dockerized environment we'll re-address when we move to Ruby 3

build/entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+echo "Building ${RAILS_ENV}"
+
+# Remove previous servers pid
+rm -f tmp/puma.pid
+
+# Guarantee gems are installed in case docker image is outdated
+./build/install_gems.sh
+
+# Do not auto-migrate for production or staging environments
+if [ "${RAILS_ENV}" != 'production' ] && [ "${RAILS_ENV}" != 'staging' ]; then
+  ./build/validate_migrated.sh
+fi
+
+echo "Migration Validated"

build/install_gems.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+if [ "${RAILS_ENV}" = 'production' ] || [ "${RAILS_ENV}" = 'staging' ]; then
+  echo "Bundle install without development or test gems."
+  bundle install --without development test
+else
+  bundle install --without production
+fi

build/validate_migrated.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+if [ "${RAILS_ENV}" = 'production' ] || [ "${RAILS_ENV}" = 'staging' ]; then
+  echo "Cannot auto-migrate ${RAILS_ENV} database, exiting"
+  exit 1
+fi
+
+echo "Checking ${RAILS_ENV} database migration status and auto-migrating if necessary."
+# If the migration status can't be read or is not fully migrated
+# then update the database with latest migrations
+if bundle exec rails db:migrate:status &> /dev/null; then
+  bundle exec rails db:migrate
+fi
+echo "Done checking ${RAILS_ENV} database migration status"

config/blacklight.yml.sample

@@ -4,6 +4,3 @@ development:
 test: &test
   adapter: solr
   url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:#{ENV.fetch('SOLR_TEST_PORT', 8985)}/solr/hydra-test" %>
-production:
-  adapter: solr
-  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>

config/database.yml.sample

@@ -1,31 +1,27 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-#
 default: &default
   adapter: mysql2
-  encoding: utf8
-  reconnect: false
-  pool: 20
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
   timeout: 5000
+  database: <%= ENV['DB_NAME'] %>
+  username: <%= ENV['DB_USERNAME'] %>
+  password: <%= ENV['DB_PASSWORD'] %>
+  host: <%= ENV['DB_HOST'] %>
+  port: <%= ENV['DB_PORT'] %>
 
 development:
   <<: *default
-  database: trove
+  database: <%= ENV.fetch('DB_NAME', 'tdl_on_hyrax') %>
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  adapter: mysql2
-  database: trove_test
-  user: root
-  password: root
-  pool: 5
-  timeout: 5000
+  <<: *default
+  database: <%= ENV.fetch('DB_NAME', 'tdl_on_hyrax_test') %>
+  username: <%= ENV.fetch('DB_USERNAME', 'root') %>
+  password: <%= ENV.fetch('DB_PASSWORD', 'root') %>
 
 production:
   <<: *default
-  database: trove
+  encoding: unicode
+  pool: 50

config/env.apple-silicon.conf

@@ -0,0 +1,10 @@
+#COMMON SETTINGS
+
+SERVER_PORTS="4000:4000"
+SERVER_EXPOSE="4000"
+TEST_PORTS="4101:4001"
+TEST_EXPOSE="4111"
+
+# APPLE SILICONE SETTINGS
+SELENIUM_IMAGE="seleniarm/standalone-chromium"
+SELENIUM_PLATFORM="linux/arm64"

config/env.intel.conf

@@ -0,0 +1,10 @@
+#COMMON SETTINGS
+
+SERVER_PORTS="4000:4000"
+SERVER_EXPOSE="4000"
+TEST_PORTS="4101:4001"
+TEST_EXPOSE="4111"
+
+# INTEL SETTINGS
+SELENIUM_IMAGE="selenium/standalone-chrome:3.141"
+SELENIUM_PLATFORM="linux/amd64"

config/fedora.yml.sample

@@ -1,15 +1,10 @@
 development:
   user: fedoraAdmin
   password: fedoraAdmin
-  url: http://127.0.0.1:<%= ENV['FCREPO_DEVELOPMENT_PORT'] || 8984 %>/rest
+  url: <%= ENV['FEDORA_URL'] || "http://127.0.0.1:#{ENV.fetch('FCREPO_DEVELOPMENT_PORT', 8984)}/rest" %>
   base_path: /dev
 test:
   user: fedoraAdmin
   password: fedoraAdmin
-  url: http://127.0.0.1:<%= ENV['FCREPO_TEST_PORT'] || 8986 %>/rest
+  url: <%= ENV['FEDORA_URL'] || "http://127.0.0.1:#{ENV.fetch('FCREPO_TEST_PORT', 8986)}/rest" %>
   base_path: /test
-production:
-  user: fedoraAdmin
-  password: fedoraAdmin
-  url: http://127.0.0.1:8983/fedora/rest
-  base_path: /prod

config/ldap.yml.sample

@@ -1,7 +1,6 @@
-## Authorizations
-# Uncomment out the merging for each environment that you'd like to include.
+# Uncomment out the merging for each enviornment that you'd like to include.
 # You can also just copy and paste the tree (do not include the "authorizations") to each
-# environment if you need something different per enviornment.
+# enviornment if you need something different per enviornment.
 authorizations: &AUTHORIZATIONS
   group_base: ou=groups,dc=test,dc=com
   ## Requires config.ldap_check_group_membership in devise.rb be true
@@ -18,18 +17,17 @@ authorizations: &AUTHORIZATIONS
     objectClass: inetOrgPerson
     authorizationRole: postsAdmin
 
-## Environment
+## Enviornments
 
 development:
-  host: localhost
+  host: ldap.tufts.edu
   port: 636
-  attribute: cn
-  base: ou=people,dc=test,dc=com
-  admin_user: cn=admin,dc=test,dc=com
-  admin_password: admin_password
-  ssl: false
+  attribute: uid
+  base: dc=tufts, dc=edu
+  admin_user: some_user
+  admin_password: some_password
+  ssl: true
   # <<: *AUTHORIZATIONS
-
 test:
   host: localhost
   port: 3897
@@ -39,7 +37,6 @@ test:
   admin_password: admin_password
   ssl: false
   # <<: *AUTHORIZATIONS
-
 production:
   host: localhost
   port: 636