M1 compatibility (#578)

* updates ruby

* Some changes to make etda workflow work with m1 macs

* upgrade docker ci-utils image to 3.0.0 for all ci builds

* Adds selenium container back in to e used in ci

* update readme and adds container name

Co-authored-by: whereismyjetpack <djb44@psu.edu>

Author: ajkiessl

.circleci/config.yml

@@ -21,7 +21,7 @@ jobs:
             ./bin/pr-release clusters/prod/manifests/prod.yaml
   build:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v2.0.1
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow
@@ -55,7 +55,7 @@ jobs:
           - cc-test-reporter
   rubocop:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v1.1.0
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow
@@ -74,7 +74,7 @@ jobs:
           RAILS_ENV=test docker-compose run --name=rubocop test bundle exec rubocop
   integration_test_grad:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v1.1.0
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow
@@ -101,7 +101,7 @@ jobs:
           - integration_coverage.json
   unit_test_grad:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v1.1.0
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow
@@ -128,7 +128,7 @@ jobs:
             - unit_coverage.json
   publish:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v1.1.0
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow
@@ -164,7 +164,7 @@ jobs:
                   docker push $REGISTRY_URL:latest
   test_partners:
     docker:
-      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v1.1.0
+      - image: harbor.k8s.libraries.psu.edu/library/ci-utils:v3.0.0
     environment:
       REGISTRY_HOST: harbor.k8s.libraries.psu.edu
       REGISTRY_URL: harbor.k8s.libraries.psu.edu/library/etda-workflow

README.md

@@ -2,15 +2,15 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/a38c9040c48fe53aaa85/maintainability)](https://codeclimate.com/github/psu-libraries/etda_workflow/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a38c9040c48fe53aaa85/test_coverage)](https://codeclimate.com/github/psu-libraries/etda_workflow/test_coverage)
 
-# Electronic Theses and Dissertations Workflow 
+# Electronic Theses and Dissertations Workflow
 
 * Ruby version: 2.7
 * Node version 10 (using yarn as npm)
 * Rails 6
 * Redis 3
 * Sidekiq 5
 * Mariadb 10
- 
+
 ## Setup
 
 Clone the repo to your local device and `cd` to the project root directory
@@ -19,43 +19,43 @@ Clone the repo to your local device and `cd` to the project root directory
 
 *Run `make` or view the Makefile for target definitions*
 
-To build the image and run containers:
+To build the image and run necessary containers:
 
- 1. `make build`
- 2. `make up`
+ 1. `docker-compose build`
+ 2. `docker-compose up -d seleniarm db redis web` **_Note:_** Use `seleniarm` with ARM architecture and `selenium` with others
  3. Check it out at `localhost:3000` in your browser
-    
+
 To copy database data into container:
 
 1. Retrieve an sql dump or compressed backup of the prod or staging database
 2. `docker cp /path/to/file.sql.gz {db_container}:/`
-3. `docker-compose exec db bash` 
+3. `docker-compose exec db bash`
 4. Unzip file if compressed using `gunzip`
-5. `mysql -u root -p -D {database_name} < /path/to/file.sql` 
-    
+5. `mysql -u root -p -D {database_name} < /path/to/file.sql`
+
 To create mock submission files:
 
 *This should be done after the database data is created, or else nothing will be created*
 
-1. `make exec` (running bash in the web container)
+1. `docker-compose exec web bash` (running bash in the web container)
 2. `rake etda_files:create:empty_files` (this may take a while)
 
 To seed data:
 
-1. `make exec`
+1. `docker-compose exec web bash`
 2. `PARTNER={parter} bundle exec rake db:seed:essential`
-    
+
 You're good to go from here!  Any changes made in the project files on your local machine will automatically be updated in the container.  Run `make restart` to restart the puma server if changes do not appear in the web browser.  Remember to check the Makefile for more commands.  If you are running a shell in the web container, you can run all of the rails commands you would normally use for development: ie `rspec, rails restart, rails c, etc.`
 
 ## Testing
- 
-   To run the tests: 
+
+   To run the tests:
    1.  `RAILS_ENV=test bundle exec rspec` tests Graduate School instance   
    2.  `RAILS_ENV=test bundle exec PARTNER=honors rspec` tests Honors College instance
    3.  `RAILS_ENV=test PARTNER=milsch bundle exec rspec` tests Millennium Scholars instance
-   
+
    Running the entire test suite for each partner can take a while.  To run tests for non-graduate instances that are unique to that instance, use tags like this:
-   
+
    1. `RAILS_ENV=test PARTNER=milsch bundle exec rspec --tag milsch`
    1. `RAILS_ENV=test PARTNER=honors bundle exec rspec --tag honors`
 

config/environments/development.rb

@@ -77,7 +77,8 @@
 
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
-  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+  # config.file_watcher = ActiveSupport:: EventedFileUpdateChecker // this code doesn't work with M1 chip MacBooks
+  config.file_watcher = ActiveSupport::FileUpdateChecker
 
   # Mocks
   # TODO Remove constants from initializer (autoload to deprecate in future Rails versions)

docker-compose.yml

@@ -1,5 +1,13 @@
 version: '3.5'
 services:
+  # Can be used locally with M1 Macs in place of the selenuim container
+  seleniarm:
+    image: seleniarm/standalone-chromium
+    volumes:
+      - /dev/shm:/dev/shm
+    ports:
+      - "4444:4444"
+    container_name: selenium
   selenium:
     image: selenium/standalone-chrome
     volumes:
@@ -26,7 +34,7 @@ services:
     user: root
     image: etda_workflow_web:latest
     # build:
-      # context: . 
+      # context: .
       # target: base
     environment:
       JS: ${JS:-false}
@@ -56,7 +64,7 @@ services:
     stdin_open: true
     user: root
     build:
-      context: . 
+      context: .
       target: base
     environment:
       REDIS_HOST: redis