From 77bf59d2f1c1656eafbd0dd5d07abd85c730490b Mon Sep 17 00:00:00 2001 From: Camila Maia Date: Mon, 14 Jun 2021 10:32:49 -0300 Subject: [PATCH 1/2] Testing github action for website tutorial --- .github/workflows/scanapi-action.yml | 28 +++++++++++++++++++ {demo-api => scanapi}/.env | 0 {demo-api => scanapi}/README.md | 0 {demo-api => scanapi}/csv_template.jinja | 0 {demo-api => scanapi}/scanapi-report.csv | 0 {demo-api => scanapi}/scanapi-report.html | 0 {demo-api => scanapi}/scanapi.conf | 0 {demo-api => scanapi}/scanapi.yaml | 2 +- {demo-api => scanapi}/snippets.yaml | 0 .../tests/body_equals_ok.yaml | 0 .../tests/code_in_content.yaml | 0 .../tests/highlight_in_content.yaml | 0 .../tests/id_in_content.yaml | 0 .../tests/key_in_content.yaml | 0 .../tests/language_in_content.yaml | 0 .../tests/linenos_in_content.yaml | 0 .../tests/owner_in_content.yaml | 0 .../tests/response_time.yaml | 0 .../tests/status_code_is_200.yaml | 0 .../tests/status_code_is_201.yaml | 0 .../tests/status_code_is_204.yaml | 0 .../tests/style_in_content.yaml | 0 .../tests/title_in_content.yaml | 0 .../tests/url_in_content.yaml | 0 {demo-api => scanapi}/users.yaml | 0 25 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/scanapi-action.yml rename {demo-api => scanapi}/.env (100%) rename {demo-api => scanapi}/README.md (100%) rename {demo-api => scanapi}/csv_template.jinja (100%) rename {demo-api => scanapi}/scanapi-report.csv (100%) rename {demo-api => scanapi}/scanapi-report.html (100%) rename {demo-api => scanapi}/scanapi.conf (100%) rename {demo-api => scanapi}/scanapi.yaml (94%) rename {demo-api => scanapi}/snippets.yaml (100%) rename {demo-api => scanapi}/tests/body_equals_ok.yaml (100%) rename {demo-api => scanapi}/tests/code_in_content.yaml (100%) rename {demo-api => scanapi}/tests/highlight_in_content.yaml (100%) rename {demo-api => scanapi}/tests/id_in_content.yaml (100%) rename {demo-api => scanapi}/tests/key_in_content.yaml (100%) rename {demo-api => scanapi}/tests/language_in_content.yaml (100%) rename {demo-api => scanapi}/tests/linenos_in_content.yaml (100%) rename {demo-api => scanapi}/tests/owner_in_content.yaml (100%) rename {demo-api => scanapi}/tests/response_time.yaml (100%) rename {demo-api => scanapi}/tests/status_code_is_200.yaml (100%) rename {demo-api => scanapi}/tests/status_code_is_201.yaml (100%) rename {demo-api => scanapi}/tests/status_code_is_204.yaml (100%) rename {demo-api => scanapi}/tests/style_in_content.yaml (100%) rename {demo-api => scanapi}/tests/title_in_content.yaml (100%) rename {demo-api => scanapi}/tests/url_in_content.yaml (100%) rename {demo-api => scanapi}/users.yaml (100%) diff --git a/.github/workflows/scanapi-action.yml b/.github/workflows/scanapi-action.yml new file mode 100644 index 0000000..9e7f43a --- /dev/null +++ b/.github/workflows/scanapi-action.yml @@ -0,0 +1,28 @@ +name: Document and Test +on: + pull_request + +jobs: + deploy-on-staging: + runs-on: ubuntu-latest + steps: + - run: echo "Your staging deploy action here!" + scanapi: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Run automated API tests + uses: scanapi/github-action@v1 + env: + USER: ${{ secrets.USER }} + PASSWORD: ${{ secrets.PASSWORD }} + with: + scanapi_version: '==2.4.0' + arguments: run ./scanapi/scanapi.yaml -c ./scanapi/scanapi.conf -o ./scanapi/scanapi-report.html + - name: Upload scanapi-report.html + uses: actions/upload-artifact@v2 + if: ${{ always() }} + with: + name: ScanAPI Report + path: ./scanapi/scanapi-report.html + needs: [deploy-on-staging] diff --git a/demo-api/.env b/scanapi/.env similarity index 100% rename from demo-api/.env rename to scanapi/.env diff --git a/demo-api/README.md b/scanapi/README.md similarity index 100% rename from demo-api/README.md rename to scanapi/README.md diff --git a/demo-api/csv_template.jinja b/scanapi/csv_template.jinja similarity index 100% rename from demo-api/csv_template.jinja rename to scanapi/csv_template.jinja diff --git a/demo-api/scanapi-report.csv b/scanapi/scanapi-report.csv similarity index 100% rename from demo-api/scanapi-report.csv rename to scanapi/scanapi-report.csv diff --git a/demo-api/scanapi-report.html b/scanapi/scanapi-report.html similarity index 100% rename from demo-api/scanapi-report.html rename to scanapi/scanapi-report.html diff --git a/demo-api/scanapi.conf b/scanapi/scanapi.conf similarity index 100% rename from demo-api/scanapi.conf rename to scanapi/scanapi.conf diff --git a/demo-api/scanapi.yaml b/scanapi/scanapi.yaml similarity index 94% rename from demo-api/scanapi.yaml rename to scanapi/scanapi.yaml index 28a5df2..686428e 100644 --- a/demo-api/scanapi.yaml +++ b/scanapi/scanapi.yaml @@ -1,6 +1,6 @@ endpoints: - name: snippets-api - path: ${BASE_URL} + path: http://demo.scanapi.dev/api/v1/ headers: Content-Type: application/json requests: diff --git a/demo-api/snippets.yaml b/scanapi/snippets.yaml similarity index 100% rename from demo-api/snippets.yaml rename to scanapi/snippets.yaml diff --git a/demo-api/tests/body_equals_ok.yaml b/scanapi/tests/body_equals_ok.yaml similarity index 100% rename from demo-api/tests/body_equals_ok.yaml rename to scanapi/tests/body_equals_ok.yaml diff --git a/demo-api/tests/code_in_content.yaml b/scanapi/tests/code_in_content.yaml similarity index 100% rename from demo-api/tests/code_in_content.yaml rename to scanapi/tests/code_in_content.yaml diff --git a/demo-api/tests/highlight_in_content.yaml b/scanapi/tests/highlight_in_content.yaml similarity index 100% rename from demo-api/tests/highlight_in_content.yaml rename to scanapi/tests/highlight_in_content.yaml diff --git a/demo-api/tests/id_in_content.yaml b/scanapi/tests/id_in_content.yaml similarity index 100% rename from demo-api/tests/id_in_content.yaml rename to scanapi/tests/id_in_content.yaml diff --git a/demo-api/tests/key_in_content.yaml b/scanapi/tests/key_in_content.yaml similarity index 100% rename from demo-api/tests/key_in_content.yaml rename to scanapi/tests/key_in_content.yaml diff --git a/demo-api/tests/language_in_content.yaml b/scanapi/tests/language_in_content.yaml similarity index 100% rename from demo-api/tests/language_in_content.yaml rename to scanapi/tests/language_in_content.yaml diff --git a/demo-api/tests/linenos_in_content.yaml b/scanapi/tests/linenos_in_content.yaml similarity index 100% rename from demo-api/tests/linenos_in_content.yaml rename to scanapi/tests/linenos_in_content.yaml diff --git a/demo-api/tests/owner_in_content.yaml b/scanapi/tests/owner_in_content.yaml similarity index 100% rename from demo-api/tests/owner_in_content.yaml rename to scanapi/tests/owner_in_content.yaml diff --git a/demo-api/tests/response_time.yaml b/scanapi/tests/response_time.yaml similarity index 100% rename from demo-api/tests/response_time.yaml rename to scanapi/tests/response_time.yaml diff --git a/demo-api/tests/status_code_is_200.yaml b/scanapi/tests/status_code_is_200.yaml similarity index 100% rename from demo-api/tests/status_code_is_200.yaml rename to scanapi/tests/status_code_is_200.yaml diff --git a/demo-api/tests/status_code_is_201.yaml b/scanapi/tests/status_code_is_201.yaml similarity index 100% rename from demo-api/tests/status_code_is_201.yaml rename to scanapi/tests/status_code_is_201.yaml diff --git a/demo-api/tests/status_code_is_204.yaml b/scanapi/tests/status_code_is_204.yaml similarity index 100% rename from demo-api/tests/status_code_is_204.yaml rename to scanapi/tests/status_code_is_204.yaml diff --git a/demo-api/tests/style_in_content.yaml b/scanapi/tests/style_in_content.yaml similarity index 100% rename from demo-api/tests/style_in_content.yaml rename to scanapi/tests/style_in_content.yaml diff --git a/demo-api/tests/title_in_content.yaml b/scanapi/tests/title_in_content.yaml similarity index 100% rename from demo-api/tests/title_in_content.yaml rename to scanapi/tests/title_in_content.yaml diff --git a/demo-api/tests/url_in_content.yaml b/scanapi/tests/url_in_content.yaml similarity index 100% rename from demo-api/tests/url_in_content.yaml rename to scanapi/tests/url_in_content.yaml diff --git a/demo-api/users.yaml b/scanapi/users.yaml similarity index 100% rename from demo-api/users.yaml rename to scanapi/users.yaml From 8b0727f7ffc6bec4adb9b98e569bdfe87d32c93a Mon Sep 17 00:00:00 2001 From: Camila Maia Date: Mon, 14 Jun 2021 12:00:17 -0300 Subject: [PATCH 2/2] testing circleci --- .circleci/config.yml | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..eb1627a --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,38 @@ +version: 2.1 + +workflows: + main: + jobs: + - deploy-on-staging: + filters: + branches: + only: + - website-tutorial-ci + - scanapi: + requires: + - deploy-on-staging + filters: + branches: + only: + - website-tutorial-ci + +jobs: + deploy-on-staging: + docker: + - image: cimg/node:14.10.1 + steps: + - run: echo "Your staging deploy job here!" + scanapi: + docker: + - image: camilamaia/scanapi:2.4.0 + environment: + USER: $USER + PASSWORD: $PASSWORD + steps: + - checkout + - run: + name: Run ScanAPI + command: | + scanapi run scanapi/scanapi.yaml -c scanapi/scanapi.conf -o scanapi/report.html + - store_artifacts: + path: scanapi/report.html