Skip to main content

API testing for BC Data Catalog

Project description

Automated BCDC API Testing

Intention is to test the CKAN API after deployment.

Current tests include:

  • verification of preconfigured orgs required for testing
  • CRUD tests for packages.

OC Build for BCDC-TEST

pulls package from https://pypi.org/project/bcdc-apitests/ new OC build triggered by github actions on commit to master branch

how to create new build from build config

oc create -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/bcdc-test-buildconfig.yaml

start build

oc start-build bcdc-test -n databcdc

OC Jobs for BCDC-TEST

each environment will have its own defined .yaml file within the k8s dir.

  • test-dwelf-job-template.yaml
  • test-toyger-job-template.yaml

how to run job from yaml as template, so we can change the name using a generated value appended to name

  • CADI
oc process -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/test-dwelf-job-template.yaml | oc create -f -
  • CATI
oc process -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/test-toyger-job-template.yaml | oc create -f -

OC Development Build for BCDC-TEST-DEV

pulls from https://pypi.org/project/bcdc-apitests-dev/ new OC build triggered by github actions on push to dev branch

oc create -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/bcdc-test-buildconfig-dev.yaml

OC Developmnet Jobs for BCDC-TEST-DEV

  • CADI
oc process -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/test-dwelf-job-template-dev.yaml | oc create -f -
  • CATI
oc process -f https://raw.githubusercontent.com/bcgov/bcdc-test/dev/k8s/test-toyger-job-template-dev.yaml | oc create -f -

Run Tests locally

pip install bcdc_apitests
pytest --pyargs bcdc_apitests --junitxml=<xml report name.xml>

Packaging

disable teardown

--df Include this switch if you want to disable teardown that deletes the test data that gets generated by the test suite. The various options basically tell the test suite not to delete a particular type of data that are generated by the tests.

Options include:

  • orgs
  • groups
  • packages
  • resources
  • users
  • other
  • ALL

Packaging

Packaging is currently configured to be built automatically by github actions when a pull request on master has been successfully merged.

packaging version numbers

When a new package is built it will automatically check what the last version is in PYPI for the package and increment that number.

Example if the version in pypi is 7.3.45, the next time the github action triggers it will be 7.3.46. If you want the change either the major or the minor number set the number in packages init.py file, for example to increment the major version number to 8.

...
version=8.0.0
...

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bcdc-apitests-dev-1.0.13.tar.gz (69.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bcdc_apitests_dev-1.0.13-py3-none-any.whl (97.0 kB view details)

Uploaded Python 3

File details

Details for the file bcdc-apitests-dev-1.0.13.tar.gz.

File metadata

  • Download URL: bcdc-apitests-dev-1.0.13.tar.gz
  • Upload date:
  • Size: 69.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for bcdc-apitests-dev-1.0.13.tar.gz
Algorithm Hash digest
SHA256 a3a8a20343a7827f3fb0b4a00a5d14c3d8624520073392f488db9b6bbedb9026
MD5 1e0770821bc958f24b18a8c179754978
BLAKE2b-256 ede9f078d92a74d6311284cb671c3ae28699e2f3434a81a1ecf5550a22739a4e

See more details on using hashes here.

File details

Details for the file bcdc_apitests_dev-1.0.13-py3-none-any.whl.

File metadata

  • Download URL: bcdc_apitests_dev-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 97.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for bcdc_apitests_dev-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 519548da9326d2352bd37407dfcfec51c86444d7d7ccecfc6591f3c7fc186718
MD5 49a9af55512ecc92c428f2ee42e09321
BLAKE2b-256 df7efd1b311b8800df566fc02d91549ae868a7294a171a5479279c33a486ae0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page