Automated Integration Testing and Live Documentation for your API

Description

Added a pre-commit hook to check if follow the conventional commits.

Motivation behind this PR?

QA

What type of change is this?

Check if commit message follow the conventional commits.

Checklist

• [x] I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• [ ] I have added/updated unit tests. Instructions.
• [ ] New and existing unit tests pass locally with my changes. Instructions
• [ ] I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• [x] Current PR does not significantly decrease the code coverage and docstring coverage.
• [x] My code follows the style guidelines of this project.
• [ ] I have run ScanAPI locally and manually tested my changes. Instructions.

Issue

Closes #438

Architecture Decision Review - ADR

• How are we going to show the tests in the html report
• Which color should we use?
• How are we going to show each test case?
• How are we going to show if a test passed?
• How are we going to show if a test failed?
• Should we use HTTP methods with color? Yes or No?

This discussion started here

Related ADR: #164

Publish Sphinx Documentation

The #230 implemented the auto-generated code documentation using sphinx.

We can run it locally by running

$ cd documentation
$ make html

And we can access it opening the file scanapi/documentation/build/html/index.html in a browser.

This is great, but it would be nice to have this documentation published somewhere else. One option would be to publish it inside our website scanapi.dev, repository: https://github.com/scanapi/website

It would be nice to have anchor links available at each request in the report.

To share a specific request that needs review would be easier than having to scan (pun intended) through the entire report.

Architecture Decision Review - ADR

We want to implement the feature of receiving a JSON OpenAPI spec and convert it into a ScanAPI spec file.

Receive a json OpenAPI spec -> return an api.yaml file

Feature issue: https://github.com/scanapi/scanapi/issues/12

But we need to discuss how we will integrate it into the main project. Some options that came into my mind:

Option 1

A new command like: $ scanapi init OPENAPI_PATH. And leave the main command as it is.

(we would need to investigate if it is easy to do that with Click, but I believe with groups is quite feasible.)

Option 2

A new command like: $ scanapi init OPENAPI_PATH and change the main command to something like $ scanapi run SPEC_PATH

(we would need to investigate if it is easy to do that with Click, but I believe with groups is quite feasible.)

Option 3

A new command like: $ scanapi-init OPENAPI_PATH. And leave the main command as it is

(This would be pretty easy to implement with Click)

Maybe generate instead of init, don't know 🤷‍♀️

I like the options 1 and 2. For me, the downside of 2 is that we would need to change the way it is now. And the downside of 1 is that for some cases we will use scanapi directly and for other with another command, which is not so intuitive and it is also not a pattern. Option 3 is easier but I dislike it because it is ugly 😂

Do you have more ideas? What do you think about this ones? @barbosa @gillianomenezes @djalmaaraujo @abreumatheus

Given that ScanAPI already has a predefined yml structure, we could have a VSCode extension that autocompletes keys (endpoints, method, path, etc) based on where you are in the spec tree.

This would require further investigation to see what can be achieved but the following links should give some clarity:

• https://code.visualstudio.com/api/language-extensions/overview
• https://code.visualstudio.com/api/language-extensions/programmatic-language-features

Environment

• Operating System: Linux Xubuntu 16.04
• Python version: 3.6

What you intend to do with scanapi ?

A want make a request to web server running locally with HTTPS enabled, but I need some way to make requests dont verify SSL.

I need something like that? requests.post(url='https://example.com', data={'bar':'baz'}, verify=False)

Expected behavior ?

There are some option for me reach that, saying to requests include 'verify=False'?

I'm trying to avoid this error:

Error to make request https://127.0.0.1:443/auth/authenticate. HTTPSConnectionPool(host='127.0.0.1', port=443): Max retries exceeded with url: /auth/authenticate (Caused by SSLError(SSLError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:777)'),))

Thanks in advance!

scanapi has a discord server so feel free to join and say 👋 hello. Maybe share the issue link?

Description

Update the sample yaml file

Motivation behind this PR?

What type of change is this?

Checklist

• [ ] I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• [ ] I have added/updated unit tests. Instructions.
• [ ] New and existing unit tests pass locally with my changes. Instructions
• [ ] I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• [x] Current PR does not significantly decrease the code coverage and docstring coverage.
• [ ] My code follows the style guidelines of this project.
• [ ] I have run ScanAPI locally and manually tested my changes. Instructions.

Issue

Closes #368

Add the link icon to copy anchor URL

Anchor link was already implemented by PR https://github.com/scanapi/scanapi/pull/317. Now we need add an icon to each endpoint which the user can click and copy the anchor url.

Something similar of what github has:

The result would be something like this:

Related to: #260

Hi guys, recently @camilamaia has been create an video speak about ScanApi. will we add the video in readme on example session?

Video link: https://www.youtube.com/watch?v=JIo4sA8LHco&t=2s

Refers to: [#12 ]

Added

• Command convert, to convert a OpenAPI JSON file to a ScanAPI YAML friendly file;

Changed

• Command scanapi to scanapi run;
• Updated documentation to include changes and the new feature;

Bumps certifi from 2021.5.30 to 2022.12.7.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Description

Change requests to httpx

Motivation behind this PR?

#208

What type of change is this?

Feature

Checklist

• [x] I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• [x] I have added/updated unit tests. Instructions.
• [x] New and existing unit tests pass locally with my changes. Instructions
• [x] I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• [x] Current PR does not significantly decrease the code coverage and docstring coverage.
• [x] My code follows the style guidelines of this project.
• [x] I have run ScanAPI locally and manually tested my changes. Instructions.
• [x] I have squashed my commits. Instructions.

Issue

Closes #208

Description

Custom variable will be evaluated when defined in the path

Motivation behind this PR?

#508

What type of change is this?

Bug fix

Checklist

• [X] I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• [X] I have added/updated unit tests. Instructions.
• [X] New and existing unit tests pass locally with my changes. Instructions
• [ ] I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• [X] Current PR does not significantly decrease the code coverage and docstring coverage.
• [X] My code follows the style guidelines of this project.
• [X] I have run ScanAPI locally and manually tested my changes. Instructions.
• [X] I have squashed my commits. Instructions.

Issue

Closes #508

Description

Add the --insecure flag in curl based on request options

Motivation behind this PR?

Closes #554

What type of change is this?

Bug fix

Checklist

• [x] I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• [x] I have added/updated unit tests. Instructions.
• [x] New and existing unit tests pass locally with my changes. Instructions
• [x] I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• [x] Current PR does not significantly decrease the code coverage and docstring coverage.
• [x] My code follows the style guidelines of this project.
• [x] I have run ScanAPI locally and manually tested my changes. Instructions.
• [x] I have squashed my commits. Instructions.

Issue

Closes #554

Bug report

Environment

• Operating System: not relevant
• Python version: not relevant

Description of the bug

When using verify: false, the curl command generated without the --inscure / -k flag.

Expected behavior ?

The generated curl should include --insecure / -k when the request is not verified.

How to reproduce the the bug ?

endpoints:
  - name: scanapi-demo
    path: http://demo.scanapi.dev/api/
    options:
        verify: false
    requests:
      - name: list_all_devs
        path: devs/
        method: get

then

scanapi run

Then observe the genreated curl.

Anthing else we need to know?

curlify2 supports a verify argument on the to_curl method: https://github.com/marcuxyz/curlify2/blob/fc0fd402f77dea7c8c28840eeaa2886dc287f040/curlify2/curlify.py#L1

Bug report

Environment

• ScanAPI version: 2.7.0
• Chrome Version 102.0.5005.61 (Official Build) (arm64)

Description of the bug

When generating a report, the field CONTENT of the RESPONSE section is not being displayed properly

Also, the copy button is not working

Expected behavior?

How to reproduce the bug ?

Can be reproduced by generating a report or checking the reports generated on the ScanAPI examples job on GitHub actions. For example https://github.com/scanapi/scanapi/actions/runs/2426475658. Open the report on Chrome.