Refactor scripts to use environment variables and best practices (#4)

* add param to config

* fix build scripts

* remove spaces

* add missing params

* remove extra tag

* refactor to use env vars

* remove redundant error check

* add shebangs

* remove unused params and fix validation errors

* uncomment command-test

* add some more tests and call bats in ci script

* update tests

* Commit message

* Commit message

* Commit message

* Commit message

* Commit message

* try tests again

* add pwds

* fix

* add failing cd mock

* fix mock

* check for missing files

* add logs

* fix

* use grep for matching

* add logs

* set shebangs

* fix mocks

* encapsulate functions for testing

* wrap function calls to prevent calls when sourced

* fix test syntax

* use grep instead of pattern matching

* try different matching

* fix name of file and use regex to match

* add verbose logs

* fix extraction

* refactor to atomize to enable testing

* add shebang

* fix env vars for scripts

* env vars

* fix regex. remove unneeded var

* more fixes

* finally fix regex

* add orb prefix

* pass in commit message

* fix commit message and unset vars after tests

* fix expected output

Author: trevor-coleman

.circleci/config.yml

@@ -3,35 +3,13 @@ setup: true
 orbs:
   orb-tools: circleci/[email protected]
   shellcheck: circleci/[email protected]
+  bats: circleci/[email protected]
 
 filters: &filters
   tags:
     only: /.*/
 
 workflows:
-  # Prior to producing a development orb (which requires credentials) basic validation, linting, and even unit testing can be performed.
-  # This workflow will run on every commit
-  test-pack:
-    unless: << pipeline.parameters.run-integration-tests >>
-    jobs:
-      - orb-tools/lint # Lint Yaml files
-      - orb-tools/pack # Pack orb source
-      # Publish development version(s) of the orb.
-      - orb-tools/publish-dev:
-          orb-name: infinitered/publish-docs
-          context: orb-publishing # A restricted context containing your private publishing credentials. Will only execute if approved by an authorized user.
-          requires:
-            - orb-tools/lint
-            - orb-tools/pack
-            - bats/run
-            - shellcheck/check
-      # Trigger an integration workflow to test the
-      # dev:${CIRCLE_SHA1:0:7} version of your orb
-      - orb-tools/trigger-integration-tests-workflow:
-          name: trigger-integration-dev
-          context: orb-publishing
-          requires:
-            - orb-tools/publish-dev
   lint-pack:
     jobs:
       - orb-tools/lint:
@@ -44,8 +22,8 @@ workflows:
           filters: *filters
       # Triggers the next workflow in the Orb Development Kit.
       - orb-tools/continue:
-          pipeline_number:  << pipeline.number >>
+          pipeline_number: << pipeline.number >>
           vcs_type: << pipeline.project.type >>
-          orb_name: <orb-name>
-          requires: [orb-tools/lint, orb-tools/pack, orb-tools/review, shellcheck/check]
+          orb_name: infinitered/docs-publish
+          requires: [ orb-tools/lint, orb-tools/pack, orb-tools/review, shellcheck/check ]
           filters: *filters

.circleci/test-deploy.yml

@@ -4,7 +4,7 @@ orbs:
   # Reference your orb's jobs and commands below as they will exist when built.
   orb-tools: circleci/[email protected]
   # The orb definition is intentionally not included here. It will be injected into the pipeline.
-  <orb-name>: {}
+  <orb-name>: { }
 
 # Use this tag to ensure test jobs always run,
 # even though the downstream publish job will only run on release tags.
@@ -27,8 +27,25 @@ jobs:
       - image: cimg/base:current
     steps:
       - checkout
-      # Run your orb's commands to validate them.
-      - <orb-name>/greet
+      - run:
+          name: Set Environment Variables
+          environment:
+            USE_MOCKS: "true"
+          command: echo "Environment variables set."
+      - run:
+          name: Run BATS tests
+          command: |
+            # Install Bats if needed
+            if ! command -v bats &> /dev/null
+            then
+              echo "Installing Bats"
+              git clone https://github.com/bats-core/bats-core.git
+              cd bats-core
+              sudo ./install.sh /usr/local
+              cd ..
+            fi
+            # Run Bats tests
+            bats ./src/tests/*.bats
 workflows:
   test-deploy:
     jobs:
@@ -40,12 +57,12 @@ workflows:
       - orb-tools/pack:
           filters: *release-filters
       - orb-tools/publish:
-          orb_name: <namespace>/<orb-name>
+          orb_name: infinitered/docs-publish
           vcs_type: << pipeline.project.type >>
           pub_type: production
           # Ensure this job requires all test jobs and the pack job.
           requires:
             - orb-tools/pack
             - command-test
-          context: <publishing-context>
+          context: orb-publishing
           filters: *release-filters

.idea/codeStyles/Project.xml

@@ -4,4 +4,4 @@ rules:
     line-length:
         max: 200
         allow-non-breakable-inline-mappings: true
-
+    new-line-at-end-of-file: enable

.idea/codeStyles/codeStyleConfig.xml

@@ -42,7 +42,7 @@ repository.
 | `description`     | String | Short description of the package used in indexes etc. Default is an empty string.                |
 | `label`           | String | The label that will appear in the sidebar of the docs site. Default is "package-name".           |
 | `project_name`    | String | The path where these documents will be located on the docs site. Default is an empty string.     |
-| `source_docs_path`| String | The path to the directory containing the source markdown files. Default is "./docs".              |
+| `source_docs_dir`| String | The path to the directory containing the source markdown files. Default is "./docs".              |
 
 ## Basic Example
 
@@ -64,7 +64,7 @@ workflows:
           description: "An example package."
           label: "Example Package"
           project_name: "example-package"
-          source_docs_path: "./example-docs"
+          source_docs_dir: "./example-docs"
 ```
 
 ### Handling Static Files
@@ -152,7 +152,7 @@ Clones a Docusaurus repo and adds the docs from the current repo to the target r
 | `description`   | String | Short description of the package. Default is an empty string.                |
 | `label`         | String | The label for the sidebar. Default is "package-name".                        |
 | `project_name`  | String | The path where the documents will be located on the docs site.               |
-| `source_docs_path`| String | The path to the directory containing the source markdown files. Default is "./docs".|
+| `source_docs_dir`| String | The path to the directory containing the source markdown files. Default is "./docs".|
 | `target_docs_path`| String | The path to the directory in the target repo where docs will be copied. Default is "./docs".|
 
 ---