TestingNode by camilamaia · Pull Request #152 · scanapi/scanapi

camilamaia · 2020-05-24T19:29:33Z

Description

TestingNode:

api:
  endpoints:
    - name: scanapi-demo
      path: ${BASE_URL}
      requests:
        - name: health
          method: get
          path: /health/
          tests:
            - name: Response Status is 200
              assert: ${{ response.status_code == 200 }}
            - name: Response Body Equals OK
              assert: ${{ response.content == b"OK!" }}
        - name: languages
          method: get
          path: /languages/
          tests:
            - name: Response Status is 200
              assert: ${{ response.status_code == 200 }}
      endpoints:
        - name: devs
          path: /devs/
          requests:
            - name: list_all
              method: get
              vars:
                uuid: ${{response.json()[2]["uuid"]}}
              tests:
                - name: Response Status is 200
                  assert: ${{ response.status_code == 200 }}
            - name: looking_for_new_opportunities
              method: get
              params:
                newOpportunities: true
              tests:
                - name: Response Status is 200
                  assert: ${{ response.status_code == 200 }}
            - name: not_looking_for_new_opportunities
              method: get
              params:
                newOpportunities: false
              tests:
                - name: Response Status is 200
                  assert: ${{ response.status_code == 200 }}
            - name: new
              method: post
              headers:
                x-api-key: ${DEMO_KEY}
              tests:
                - name: Response Status is 201
                  assert: ${{ response.status_code == 201 }}
              body:
                uuid: ${{uuid.uuid4().hex}}
                name: Tarik
                yearsOfExperience: 2
                languages:
                  - ruby
                    go
                newOpportunities: false
            - name: details_not_found
              path: 129e8cb2-d19c-51ad-9921-cea329bed7fa
              method: get
              tests:
                - name: Response Status is 404
                  assert: ${{ response.status_code == 404 }}
          endpoints:
            - name: details
              path: ${uuid}
              requests:
                - name: get
                  method: get
                  tests:
                    - name: Response Status is 200
                      assert: ${{ response.status_code == 200 }}
                - name: delete
                  method: delete
                  headers:
                    x-api-key: ${DEMO_KEY}
                  tests:
                    - name: Response Status is 200
                      assert: ${{ response.status_code == 200 }}
                - name: languages
                  path: languages
                  method: get
                  tests:
                    - name: Response Status is 200
                      assert: ${{ response.status_code == 200 }}

When tests passed:

Loading file .scanapi.yaml
Loading file api.yaml
Writing documentation
Making request GET http://demo.scanapi.dev/api/health/
 [PASSED] scanapi-demo::health::Response Status is 200
 [PASSED] scanapi-demo::health::Response Body Equals OK
Making request GET http://demo.scanapi.dev/api/languages/
 [PASSED] scanapi-demo::languages::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::list_all::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::looking_for_new_opportunities::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::not_looking_for_new_opportunities::Response Status is 200
Making request POST http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::new::Response Status is 201
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-51ad-9921-cea329bed7fa
 [PASSED] scanapi-demo::devs::details_not_found::Response Status is 404
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0
 [PASSED] scanapi-demo::devs::details::get::Response Status is 200
Making request DELETE http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0
 [PASSED] scanapi-demo::devs::details::delete::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0/languages
 [PASSED] scanapi-demo::devs::details::languages::Response Status is 200

The documentation was generated successfully.
It is available at scanapi-report.md

When a test fails:

Loading file .scanapi.yaml
Loading file api.yaml
Writing documentation
Making request GET http://demo.scanapi.dev/api/health/
 [PASSED] scanapi-demo::health::Response Status is 200
 [PASSED] scanapi-demo::health::Response Body Equals OK
Making request GET http://demo.scanapi.dev/api/languages/
 [PASSED] scanapi-demo::languages::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::list_all::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::looking_for_new_opportunities::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::not_looking_for_new_opportunities::Response Status is 200
Making request POST http://demo.scanapi.dev/api/devs/
 [PASSED] scanapi-demo::devs::new::Response Status is 201
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-51ad-9921-cea329bed7fa
 [PASSED] scanapi-demo::devs::details_not_found::Response Status is 404
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0
 [FAILED] scanapi-demo::devs::details::get::Response Status is 200
	  response.status_code == 300 is false
Making request DELETE http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0
 [PASSED] scanapi-demo::devs::details::delete::Response Status is 200
Making request GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0/languages
 [PASSED] scanapi-demo::devs::details::languages::Response Status is 200

The documentation was generated successfully.
It is available at scanapi-report.md

Closes #11

Next Steps:

Save tests information in a session.
Exit the program with an error when a test fails
Move information about tests to console/markdown/html reports

camilamaia · 2020-05-25T12:30:47Z

+        )
+        passed = "PASSED" if passed else "FAILED"
+        print(
+            f"[{passed}] {self.request.endpoint.name}::{self.request.name}::{self.name}"


We need to iterate here to check if there are more parent endpoints

github-actions · 2020-05-27T22:32:33Z

@camilamaia your pull request is missing a changelog!

camilamaia · 2020-05-31T23:08:18Z

@@ -1,3 +1,2 @@
 [pytest]
 addopts=-svvl
-bdd_features_base_dir = tests/functional/features/


We are not using pytest-bdd anymore

camilamaia · 2020-05-31T23:09:38Z

Codecov report: https://codecov.io/github/scanapi/scanapi/commit/11088d4124e876aa350e8d105c53964e5c488c1d

winstonf88 · 2020-06-01T12:40:04Z

+        try:
+            assert eval(code)
+            return (True, None)
+        except AssertionError as ae:


Suggested change

except AssertionError as ae:

except AssertionError:

winstonf88 · 2020-06-01T12:42:48Z

+        if self.is_root or not self.parent.name:
+            return name
+
+        return "::".join((self.parent.name, name))


Suggested change

return "::".join((self.parent.name, name))

return f"{self.parent.name}::{name}"

winstonf88 · 2020-06-01T12:43:57Z


    @classmethod
-    def evaluate(cls, sequence, vars):
+    def evaluate(cls, sequence, vars, is_a_test_case=False):


this is_a_test_case looks kind of scattered all over

@winstonf88 Hmmm indeed... Any ideas of how to minimize it?

I tried to isolate it a bit more in a separated evaluate_assertion method, but we can do better in the future for sure.

Really cool! it's much more isolated. Great job.

Thanks, man 💚

gillianomenezes

This is a pretty cool feature!

camilamaia force-pushed the assert branch from 917ed18 to 62b4776 Compare May 24, 2020 19:34

camilamaia changed the base branch from master to validate-keys May 25, 2020 11:30

camilamaia self-assigned this May 25, 2020

camilamaia changed the title ~~Assert~~ Add TestingNode May 25, 2020

camilamaia changed the title ~~Add TestingNode~~ TestingNode May 25, 2020

camilamaia added the Feature New feature or request label May 25, 2020

camilamaia force-pushed the validate-keys branch from 4ac9dd3 to 2b95986 Compare May 25, 2020 12:11

camilamaia commented May 25, 2020

View reviewed changes

camilamaia force-pushed the validate-keys branch 2 times, most recently from 7b85f08 to b19b924 Compare May 27, 2020 22:19

Base automatically changed from validate-keys to master May 27, 2020 22:22

camilamaia force-pushed the assert branch from 62b4776 to 0e754b1 Compare May 27, 2020 22:32

camilamaia force-pushed the assert branch 4 times, most recently from 94f8b71 to 8989cd5 Compare May 31, 2020 22:30

camilamaia marked this pull request as ready for review May 31, 2020 22:35

camilamaia requested review from barbosa, djalmaaraujo and gillianomenezes May 31, 2020 22:35

camilamaia force-pushed the assert branch from 8989cd5 to 9ff9778 Compare May 31, 2020 23:01

camilamaia commented May 31, 2020

View reviewed changes

camilamaia requested review from winstonf88 and removed request for djalmaaraujo June 1, 2020 12:32

winstonf88 reviewed Jun 1, 2020

View reviewed changes

winstonf88 approved these changes Jun 1, 2020

View reviewed changes

camilamaia force-pushed the assert branch 2 times, most recently from 5cd5201 to 6c716d5 Compare June 1, 2020 13:14

camilamaia added 2 commits June 1, 2020 10:35

Testing Node

d70be6e

Update CHANGELOG.md

a9fbfc6

camilamaia force-pushed the assert branch from 6c716d5 to a9fbfc6 Compare June 1, 2020 13:35

gillianomenezes approved these changes Jun 1, 2020

View reviewed changes

winstonf88 approved these changes Jun 2, 2020

View reviewed changes

camilamaia merged commit 124983c into master Jun 2, 2020

camilamaia deleted the assert branch June 2, 2020 14:31

camilamaia mentioned this pull request Jun 25, 2020

Release v1.0.0 #192

Merged

vnaydionov mentioned this pull request Jul 25, 2020

More explicit chaining of queries #224

Open

camilamaia mentioned this pull request Jul 25, 2020

Tests Doc Page scanapi/website#11

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

TestingNode#152

TestingNode#152
camilamaia merged 2 commits intomasterfrom
assert

camilamaia commented May 24, 2020 •

edited

Loading

Uh oh!

camilamaia May 25, 2020

Uh oh!

github-actions bot commented May 27, 2020

Uh oh!

camilamaia May 31, 2020

Uh oh!

camilamaia commented May 31, 2020

Uh oh!

winstonf88 Jun 1, 2020

Uh oh!

winstonf88 Jun 1, 2020

Uh oh!

winstonf88 Jun 1, 2020

Uh oh!

camilamaia Jun 1, 2020

Uh oh!

camilamaia Jun 1, 2020 •

edited

Loading

Uh oh!

winstonf88 Jun 2, 2020

Uh oh!

camilamaia Jun 2, 2020

Uh oh!

gillianomenezes left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	return "::".join((self.parent.name, name))
	return f"{self.parent.name}::{name}"

Uh oh!

Conversation

camilamaia commented May 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 27, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamaia commented May 31, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamaia Jun 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gillianomenezes left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

camilamaia commented May 24, 2020 •

edited

Loading

camilamaia Jun 1, 2020 •

edited

Loading