Merge pull request #3 from devatherock/tests

chore: Added functional tests to CI pipeline

Author: devatherock

.circleci/config.yml

@@ -1,6 +1,6 @@
 slack_image: &slack_image
   docker:
-    - image: devatherock/simple-slack:0.5.0
+    - image: devatherock/simple-slack:0.7.0
       auth:
         username: $DOCKER_USERNAME
         password: $DOCKER_PASSWORD
@@ -23,6 +23,13 @@ executors:
 
 version: 2.1
 jobs:
+  docker_build_dry_run:
+    executor: docker-executor
+    steps:
+      - checkout
+      - setup_remote_docker
+      - run: docker build .
+
   publish:
     executor: docker-executor
     steps:
@@ -36,6 +43,26 @@ jobs:
           docker push devatherock/minify-js:$TAG
           docker push devatherock/minify-js:latest
           
+  functional_test:
+    machine:
+      image: ubuntu-2004:202010-01
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/minify-js
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "build.gradle" }}
+            - v1-dependencies-
+      - run: |
+          ./gradlew test
+      - store_test_results:
+          path: build/test-results
+      - save_cache:
+          paths:
+            - ~/.gradle
+          key: v1-dependencies-{{ checksum "build.gradle" }}
+          
   publish_release:
     executor: docker-executor
     steps:
@@ -47,14 +74,7 @@ jobs:
           docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD
           docker pull devatherock/minify-js:$DEV_TAG
           docker tag devatherock/minify-js:$DEV_TAG devatherock/minify-js:$TAG
-          docker push devatherock/minify-js:$TAG 
-
-  docker_build_dry_run:
-    executor: docker-executor
-    steps:
-      - checkout
-      - setup_remote_docker
-      - run: docker build .
+          docker push devatherock/minify-js:$TAG
 
   notify:
     <<: *slack_image
@@ -77,12 +97,17 @@ workflows:
           filters:
             branches:
               only: master
+      - functional_test:
+          context:
+            - docker-credentials
+          requires:
+            - publish
       - notify:
           context:
             - docker-credentials
             - slack-webhook
           requires:
-            - publish
+            - functional_test
   release:
     jobs:
       - publish_release:

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [Unreleased]
+### Added
+- Functional tests to CI pipeline
+
 ## [1.0.2] - 2021-02-08
 ### Added
 - test: Added tests to test the final docker image

DOCS.md

@@ -9,34 +9,82 @@ Github action/CI Plugin to minify html, javascript and css files, using [minify]
 
 ## Usage
 ### Github Action
-Please refer [action.yml](action.yml) for parameters.
+The following parameters can be set to configure the action.
+
+*   **directory** - File to minify or a folder containing files to minify. By default, all files in current folder and
+  its sub-folders will be minified
+
+*   **output** - Path where the minified files will be saved. By default, the minified files will be saved in the
+  original file path
+
+*   **add_suffix** - Indicates if the output files should have the suffix `.min` added after the name. Default is true
 
 ```yaml
 jobs:
   build:
     runs-on: ubuntu-latest      # Docker-based github actions have to run on a linux environment
     steps:
       - name: HTML/CSS/JS Minifier
-        uses: docker://devatherock/minify-js:latest   # To use a specific release, use a docker tag like 1.0.2 instead of latest
+        uses: docker://devatherock/minify-js:1.0.2
         with:
           directory: 'src'      # Optional
           output: 'minify/src'  # Optional
           add_suffix: false     # Optional
 ```
 
 ### Docker
+
 ```shell
 docker run --rm \
   -v "/path/to/files":/work \
   -w=/work \
   -e PARAMETER_INPUT_PATH=/work/src \
   -e PARAMETER_OUTPUT_PATH=/work/minify/src \
   -e PARAMETER_ADD_SUFFIX=false \
-  devatherock/minify-js:latest
+  devatherock/minify-js:1.0.2
+```
+
+### vela
+The following parameters can be set to configure the plugin.
+
+*   **input_path** - File to minify or a folder containing files to minify. By default, all files in current folder and
+  its sub-folders will be minified
+
+*   **output_path** - Path where the minified files will be saved. By default, the minified files will be saved in the
+  original file path
+
+*   **add_suffix** - Indicates if the output files should have the suffix `.min` added after the name. Default is true
+
+```yaml
+steps:
+  - name: minify_js
+    ruleset:
+      branch: master
+      event: push
+    image: devatherock/minify-js:1.0.2
+    parameters:
+      input_path: src
+      output_path: minify/src
+      add_suffix: false
 ```
 
-### vela/CircleCI
-Please refer [docs](DOCS.md)
+### CircleCI
+
+```yaml
+version: 2.1
+jobs:
+  minify_js:
+    docker:
+      - image: devatherock/minify-js:1.0.2
+    working_directory: ~/my-repo
+    environment:
+      PARAMETER_INPUT_PATH: src
+      PARAMETER_OUTPUT_PATH: minify/src
+      PARAMETER_ADD_SUFFIX: false
+    steps:
+      - checkout
+      - run: sh /entrypoint.sh
+```
 
 ## Tests
 To test the latest plugin image, run the below command