stack_car 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80132883ba506f9cf4414a46f560a2040e8843596b7a94e3d6f9baab6ae3a4d4
-  data.tar.gz: bb84c75a79f699e7bb04aa877eaed36f3acb9e8c8d9bf294d9f4fa7bbe579ddc
+  metadata.gz: f65e5a4cb61c3b0ae89c7a41866723cfb7caf9e1853a566279eb178181746774
+  data.tar.gz: 6624f7b9f2bb1dc6faea803a4d8f19cf97fdc03939a90082c20600c4021066f6
 SHA512:
-  metadata.gz: 1e03c8620fcd08038774e75c2cfeefa75a2bae7d42708c0240c774e3584391695a87349c50bba6b0c7b444e46e66d73b2e96b1439bbf09f0104670b83e3fb831
-  data.tar.gz: 3196614e6fd6ce06b7408aa292e4ae0b19ef57aa9df8643899fcf378ad840a2d4d469695010ca04948676b9a46b7b655947cbaa0bf686c59c27b3b385b73341a
+  metadata.gz: ef5bd6bfac0e8c0301778a79bdb17cb7f23d22cdab0e661d951f734b16de61a69288eb4c923aee552de339811f0a45b55a5645e55042b067e86965cb0421ac30
+  data.tar.gz: b7fd067e699c6a93f38d4c384de5f7270b6a7fc61b6e28fce4c380bdf77599e278f57d762e825a80f893fe2c435c73679c7542aff9fee32fe37ebb5fa8c7c702

data/.github/workflows/rspec-action.yaml

@@ -0,0 +1,35 @@
+name: Test
+on: 
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs: 
+  rspec:
+    name: Run rspec with ruby
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Cache
+      uses: actions/cache@v2.1.3
+      with:
+        path: vendor/bundle
+        key: '2.3'
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1.59.1
+      with:
+        ruby-version: '2.3'
+    - name: Dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install
+    - name: Rspec
+      run: 'bundle exec rspec'
+    - name: Publish Test Report
+      uses: mikepenz/action-junit-report@v3
+      if: always() # always run even if the previous step fails
+      with:
+        report_paths: '**/build/test-results/test/TEST-*.xml'

data/README.md

@@ -26,14 +26,14 @@ Commands are accesible via the "sc" short cut. Note: this will need to be in you
 
 ```ruby
 Commands:
-  stack_car bundle_exec ARGS  # wraps docker-compose exec web bundle exec unless --service is used to specify (sc be ARGS)
+  stack_car bundle_exec ARGS  # wraps docker compose exec web bundle exec unless --service is used to specify (sc be ARGS)
   stack_car console ARGS      # shortcut to start rails console
   stack_car dockerize DIR     # Will copy the docker tempates in to your project, see options for supported dependencies
-  stack_car exec ARGS         # wraps docker-compose exec web unless --service is used to specify
+  stack_car exec ARGS         # wraps docker compose exec web unless --service is used to specify
   stack_car help [COMMAND]    # Describe available commands or one specific command
-  stack_car stop              # starts docker-compose with rebuild and orphan removal, defaults to all
-  stack_car up                # starts docker-compose with rebuild and orphan removal, defaults to web
-  stack_car walk ARGS         # wraps docker-compose run web unless --service is used to specify
+  stack_car stop              # starts docker compose with rebuild and orphan removal, defaults to all
+  stack_car up                # starts docker compose with rebuild and orphan removal, defaults to web
+  stack_car walk ARGS         # wraps docker compose run web unless --service is used to specify
 ```
 
 ## Development
@@ -57,7 +57,10 @@ Developing stack_car often requires a rails application for you to run updated c
 - Commit your changes
 
 ### Releasing a new version
-- Update the version number in `version.rb`
+**NOTE:** You will need an account for [rubygems.org](https://rubygems.org) and be made an owner of the [stack_car gem](https://rubygems.org/gems/stack_car) in order to release a new version.
+
+- Update the version number in `version.rb`. Please follow [Semantic Versioning](https://semver.org/) guidelines.
+- Commit `version.rb` and create an MR. Once the MR is approved and merged, checkout the `main` branch and do a `git pull`.
 - Run `bundle exec rake release`
   - This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -67,6 +70,19 @@ Dockerizing your application with stack_car can be thought of in 2 steps:
 - **Generate the file templates**
 - **Customize provided templates to the requirements of the application**
 
+**Set MERGE tool**
+When using stack_car to dockerize an app, it might be necessary to merge templates as opposed to completely overwriting them. To set a tool run:
+```bash
+export THOR_MERGE=<editor>
+```
+Alternatively, set it in your shell's `rc` file (`~/.bashrc`, `~/.zshrc`, etc.)
+
+With `THOR_MERGE` set, you can enter `m` at the command prompt when there is a conflict between app and `sc` template files.
+
+*Note*: For best experience, set `THOR_MERGE` to **GUI text editor** (ie. `code` or `atom`). 
+
+Initiating a merge pulls 2 versions of the file to the editor. One is what is proposed by stack_car, the other is the original. **Add what you need from the template version to the original file and save the changes**.
+
 ### Generate templates (`sc dockerize`)
 You can generate requisite files for running your application for local development in Docker with the **dockerize** command.
 

data/lib/stack_car/cli.rb

@@ -1,6 +1,6 @@
 require 'thor'
 require 'erb'
-require 'dotenv/load'
+require 'dotenv'
 require 'json'
 require 'byebug'
 module StackCar
@@ -18,17 +18,17 @@ module StackCar
     method_option :service, default: 'web', type: :string, aliases: '-s'
     method_option :build, default: false, type: :boolean, aliases: '-b'
     method_option :logs, default: true, type: :boolean
-    desc "up", "starts docker-compose with rebuild and orphan removal, defaults to web"
+    desc "up", "starts docker compose with rebuild and orphan removal, defaults to web"
     def up
       setup
       ensure_development_env
       args = ['--remove-orphans']
       args << '--build' if options[:build]
       if options[:build]
-        run("#{dotenv} docker-compose pull #{options[:service]}")
+        run("#{dotenv} docker compose pull #{options[:service]}")
       end
 
-      run_with_exit("#{dotenv} docker-compose up #{args.join(' ')} #{options[:service]}")
+      run_with_exit("#{dotenv} docker compose up #{args.join(' ')} #{options[:service]}")
     end
 
     method_option :service, default: '', type: :string, aliases: '-s'
@@ -36,7 +36,7 @@ module StackCar
     def stop
       setup
       ensure_development_env
-      run("#{dotenv} docker-compose stop #{options[:service]}")
+      run("#{dotenv} docker compose stop #{options[:service]}")
       run_with_exit("rm -rf tmp/pids/*")
     end
 
@@ -53,7 +53,7 @@ module StackCar
       ensure_development_env
 
       if options[:help]
-        run('docker-compose down --help')
+        run('docker compose down --help')
         say 'Additional stack_car options:'
         say '    -a, --all               Removes all containers, networks, volumes, and'
         say '                            images created by `up`.'
@@ -85,7 +85,7 @@ module StackCar
         args << '--timeout' if options[:timeout]
       end
 
-      run("#{dotenv} docker-compose down #{args.join(' ')}")
+      run("#{dotenv} docker compose down #{args.join(' ')}")
       run_with_exit('rm -rf tmp/pids/*')
     end
 
@@ -94,65 +94,65 @@ module StackCar
     def build
       setup
       ensure_development_env
-      run_with_exit("#{dotenv} docker-compose build #{options[:service]}")
+      run_with_exit("#{dotenv} docker compose build #{options[:service]}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "push ARGS", "wraps docker-compose push web unless --service is used to specify"
+    desc "push ARGS", "wraps docker compose push web unless --service is used to specify"
     def push(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose push #{options[:service]} #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose push #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "pull ARGS", "wraps docker-compose pull web unless --service is used to specify"
+    desc "pull ARGS", "wraps docker compose pull web unless --service is used to specify"
     def pull(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose pull #{options[:service]} #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose pull #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: '', type: :string, aliases: '-s'
-    desc "ps ARGS", "wraps docker-compose pull web unless --service is used to specify"
+    desc "ps ARGS", "wraps docker compose pull web unless --service is used to specify"
     def ps(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose ps #{options[:service]} #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose ps #{options[:service]} #{args.join(' ')}")
     end
     map status: :ps
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "bundle ARGS", "wraps docker-compose run web unless --service is used to specify"
+    desc "bundle ARGS", "wraps docker compose run web unless --service is used to specify"
     def bundle(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle")
+      run_with_exit("#{dotenv} docker compose exec #{options[:service]} bundle")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "walk ARGS", "wraps docker-compose run web unless --service is used to specify"
+    desc "walk ARGS", "wraps docker compose run web unless --service is used to specify"
     def walk(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose run #{options[:service]} #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose run #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "exec ARGS", "wraps docker-compose exec web unless --service is used to specify"
+    desc "exec ARGS", "wraps docker compose exec web unless --service is used to specify"
     def exec(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose exec #{options[:service]} #{args.join(' ')}")
     end
     map ex: :exec
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc 'sh ARGS', "launch a shell using docker-compose exec, sets tty properly"
+    desc 'sh ARGS', "launch a shell using docker compose exec, sets tty properly"
     def sh(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose exec -e COLUMNS=\"\`tput cols\`\" -e LINES=\"\`tput lines\`\" #{options[:service]} bash #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose exec -e COLUMNS=\"\`tput cols\`\" -e LINES=\"\`tput lines\`\" #{options[:service]} bash #{args.join(' ')}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
-    desc "bundle_exec ARGS", "wraps docker-compose exec web bundle exec unless --service is used to specify"
+    desc "bundle_exec ARGS", "wraps docker compose exec web bundle exec unless --service is used to specify"
     def bundle_exec(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle exec #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose exec #{options[:service]} bundle exec #{args.join(' ')}")
     end
     map be: :bundle_exec
 
@@ -160,12 +160,13 @@ module StackCar
     desc "console ARGS", "shortcut to start rails console"
     def console(*args)
       setup
-      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle exec rails console #{args.join(' ')}")
+      run_with_exit("#{dotenv} docker compose exec #{options[:service]} bundle exec rails console #{args.join(' ')}")
     end
     map rc: :console
 
     desc "release ENVIRONTMENT", "tag and push and image to the registry"
     def release(environment)
+      Dotenv.load(".env.#{environment}", '.env')
       setup
       timestamp = Time.now.strftime("%Y%m%d%I%M%S")
       sha = `git rev-parse HEAD`[0..8]
@@ -193,6 +194,7 @@ module StackCar
 
     desc "ssh ENVIRONMENT", "log in to a running instance - requires PRODUCTION_SSH to be set"
     def ssh(environment)
+      Dotenv.load(".env.#{environment}", '.env')
       setup
       target = ENV["#{environment.upcase}_SSH"]
       if target
@@ -239,7 +241,8 @@ module StackCar
       setup
       # Commandline overrides config files
       # options = file_config.merge(options)
-      @project_name = File.basename(File.expand_path(dir))
+      # Sets project name to parent directory name if working with stack_car dir
+      @project_name = @sc_dir ? File.basename(File.expand_path('..')) : File.basename(File.expand_path(dir))
       apt_packages << "libpq-dev postgresql-client" if options[:postgres]
       apt_packages << "mysql-client" if options[:mysql]
       apt_packages << "imagemagick" if options[:imagemagick]
@@ -276,6 +279,11 @@ module StackCar
      template("development.rb.erb", "config/environments/development.rb")
      template("production.rb.erb", "config/environments/production.rb")
 
+     if options[:solr]
+      template("solrcloud-upload-configset.sh", "bin/solrcloud-upload-configset.sh")
+      template("solrcloud-assign-configset.sh", "bin/solrcloud-assign-configset.sh")
+     end
+
      if File.exists?('README.md')
        prepend_to_file "README.md" do
          File.read("#{self.class.source_root}/README.md")
@@ -431,11 +439,11 @@ module StackCar
     end
 
     def find_container_by_service(service_name)
-      container_id = `docker-compose ps -aq #{service_name}`.strip
+      container_id = `docker compose ps -aq #{service_name}`.strip
 
       if container_id.empty?
         say "Unable to locate a container for the service '#{service_name}'"
-        say "Try running `docker-compose ps #{service_name}` to make sure the container exists"
+        say "Try running `docker compose ps #{service_name}` to make sure the container exists"
         exit(1)
       end
 

data/lib/stack_car/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StackCar
-  VERSION = "0.14.0"
+  VERSION = '0.16.0'
 end

data/templates/.env.erb

@@ -41,3 +41,12 @@ ES_URL=http://elasticsearch:9200
 SITE_URI=https://CHANGEME.com
 DEPLOY_HOOK=CHANGEME
 <% end -%>
+<% if options[:solr] -%>
+SOLR_URL=http://admin:admin@solr:8983/solr/<%= @project_name %>-development
+SOLR_ADMIN_PASSWORD=admin
+SOLR_ADMIN_USER=admin
+SOLR_COLLECTION_NAME=<%= @project_name %>-development
+SOLR_CONFIGSET_NAME=<%= @project_name %>
+SOLR_HOST=solr
+SOLR_PORT=8983
+<% end -%>

data/templates/.gitlab/issue_templates/enable_pipeline_check_before_merge.md

@@ -0,0 +1,8 @@
+# Gitlab Original Documentation: 
+- https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds
+
+# Notch8 Playbook Artcile with image:
+- http://playbook-staging.notch8.com/en/gitlab-only-merge-if-pipeline-succeeds
+
+# How to Video: 
+- https://share.getcloudapp.com/yAuykArv

data/templates/README.md

@@ -36,8 +36,11 @@ We recommend committing .env to your repo with good defaults. .env.development,
 
 6) Load and seed the database
     ``` bash
-    sc be rake db:migrate db: seed
+    sc be rake db:migrate db:seed
     ```
+    
+7) Visit the running instance in the browser at `project-name.test`
+
 ### Troubleshooting Docker Development Setup
 Confirm or configure settings. Sub your information for the examples.
 ``` bash

data/templates/deploy.yml.erb

@@ -29,7 +29,7 @@
     - debug: var=authout
 
     - name: Restart service
-      command: "cd {{ compose_dir }} && docker-compose -f {{ project_name }}.yml pull web && docker-compose -f {{ project_name }}.yml up -d web"
+      command: "cd {{ compose_dir }} && docker compose -f {{ project_name }}.yml pull web && docker compose -f {{ project_name }}.yml up -d web"
       environment:
         TAG: "{{ tag }}"
       register: output
@@ -62,4 +62,4 @@
         body_format: json
         status_code: 200
 
-<% end %>
+<% end %>

data/templates/docker-compose.yml.erb

@@ -51,7 +51,7 @@ services:
       - docker-entrypoint.sh
       - solr-precreate
       - mycore
-    # docker-compose exec --user=solr solr bin/solr create_core -c CORENAME
+    # docker compose exec --user=solr solr bin/solr create_core -c CORENAME
 <% end -%>
 <% if options[:redis] -%>
   redis:
@@ -129,8 +129,8 @@ services:
     ports:
       - "${WEB_PORT}"
     environment:
-      - VIRTUAL_HOST=<%= @project_name %>.docker
-      - VIRTUAL_PORT=80
+      - VIRTUAL_HOST=.<%= @project_name %>.test
+      - VIRTUAL_PORT=3000
     depends_on:
 <%= compose_depends %>
 

data/templates/solrcloud-assign-configset.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+COUNTER=0;
+
+if [ "$SOLR_ADMIN_USER" ]; then
+  solr_user_settings="--user $SOLR_ADMIN_USER:$SOLR_ADMIN_PASSWORD"
+fi
+
+solr_config_name="${SOLR_CONFIGSET_NAME:-solrconfig}"
+solr_collection_name="${SOLR_COLLECTION_NAME:-hyrax}"
+
+# Solr Cloud Collection API URLs
+solr_collection_list_url="$SOLR_HOST:$SOLR_PORT/solr/admin/collections?action=LIST"
+solr_collection_modify_url="$SOLR_HOST:$SOLR_PORT/solr/admin/collections?action=MODIFYCOLLECTION&collection=${solr_collection_name}&collection.configName=${solr_config_name}"
+
+while [ $COUNTER -lt 30 ]; do
+  if nc -z "${SOLR_HOST}" "${SOLR_PORT}"; then
+    if curl --silent $solr_user_settings "$solr_collection_list_url" | grep -q "$solr_collection_name"; then
+      echo "-- Collection ${solr_collection_name} exists; setting ${solr_config_name} ConfigSet ..."
+      echo $solr_collection_modify_url
+      curl $solr_user_settings "$solr_collection_modify_url"
+      exit
+    else
+      echo "-- Collection ${solr_collection_name} does not exist; creating and setting ${solr_config_name} ConfigSet ..."
+      solr_collection_create_url="$SOLR_HOST:$SOLR_PORT/solr/admin/collections?action=CREATE&name=${solr_collection_name}&collection.configName=${solr_config_name}&numShards=1"
+      curl $solr_user_settings "$solr_collection_create_url"
+      exit
+    fi
+  fi
+  echo "-- Looking for Solr (${SOLR_HOST}:${SOLR_PORT})..."
+  COUNTER=$(( COUNTER+1 ));
+  sleep 5s
+done
+
+echo "--- ERROR: failed to create/update Solr collection after 5 minutes";
+exit 1

data/templates/solrcloud-upload-configset.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env sh
+
+COUNTER=0;
+# /app/samvera/hyrax-webapp/solr/conf
+CONFDIR="${1}"
+
+if [ "$SOLR_ADMIN_USER" ]; then
+  solr_user_settings="--user $SOLR_ADMIN_USER:$SOLR_ADMIN_PASSWORD"
+fi
+
+solr_config_name="${SOLR_CONFIGSET_NAME:-solrconfig}"
+
+# Solr Cloud ConfigSet API URLs
+solr_config_list_url="http://$SOLR_HOST:$SOLR_PORT/api/cluster/configs?omitHeader=true"
+solr_config_upload_url="http://$SOLR_HOST:$SOLR_PORT/solr/admin/configs?action=UPLOAD&name=${solr_config_name}"
+
+while [ $COUNTER -lt 30 ]; do
+  echo "-- Looking for Solr (${SOLR_HOST}:${SOLR_PORT})..."
+  if nc -z "${SOLR_HOST}" "${SOLR_PORT}"; then
+    # shellcheck disable=SC2143,SC2086
+    if curl --silent --user 'fake:fake' "$solr_config_list_url" | grep -q '401'; then
+      # the solr pods come up and report available before they are ready to accept trusted configs
+      # only try to upload the config if auth is on.
+      if curl --silent $solr_user_settings "$solr_config_list_url" | grep -q "$solr_config_name"; then
+        echo "-- ConfigSet already exists; skipping creation ...";
+      else
+        echo "-- ConfigSet for ${CONFDIR} does not exist; creating ..."
+        (cd "$CONFDIR" && zip -r - *) | curl -X POST $solr_user_settings --header "Content-Type:application/octet-stream" --data-binary @- "$solr_config_upload_url"
+      fi
+      exit
+    else
+      echo "-- Solr at $solr_config_list_url is accepting unauthorized connections; we can't upload a trusted ConfigSet."
+      echo "--   It's possible SolrCloud is bootstrapping its configuration, so this process will retry."
+      echo "--   see: https://solr.apache.org/guide/8_6/configsets-api.html#configsets-upload"
+    fi
+  fi
+  COUNTER=$(( COUNTER+1 ));
+  sleep 5s
+done
+
+echo "--- ERROR: failed to create Solr ConfigSet after 5 minutes";
+exit 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stack_car
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec-action.yaml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
@@ -186,6 +187,7 @@ files:
 - templates/.gitlab/issue_templates/Bug.md
 - templates/.gitlab/issue_templates/Feature.md
 - templates/.gitlab/issue_templates/Question.md
+- templates/.gitlab/issue_templates/enable_pipeline_check_before_merge.md
 - templates/.gitlab/merge_request_templates/Bug.md
 - templates/.gitlab/merge_request_templates/Feature.md
 - templates/.sops.yaml.erb
@@ -243,6 +245,8 @@ files:
 - templates/ops/roles/docker.ubuntu/vars/main.yml
 - templates/production.rb.erb
 - templates/provision.yml.erb
+- templates/solrcloud-assign-configset.sh
+- templates/solrcloud-upload-configset.sh
 - templates/webapp.conf.erb
 - templates/worker.sh.erb
 homepage: https://gitlab.com/notch8/stack_car
@@ -263,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A tool to make rails + docker easy