Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a tutorial/getting started explaining how you can use this to test your own instance #2

Open
rufuspollock opened this issue Nov 16, 2020 · 2 comments

Comments

@rufuspollock
Copy link
Member

The main intent of this library (IIRC) is to provide a core set of tests and patterns that one can reuse / build on in testing specific CKAN instances. It would be good to provide a short tutorial as to how this would be done.

@cuducos
Copy link
Contributor

cuducos commented Nov 16, 2020

How would that differ from the Usage part of the README.md?

@rufuspollock
Copy link
Member Author

I think just some additions to the Usage to make it a little more friendly as per example below.

Does that help?


Usage

Cypress is a standard integration/functional testing library that allows you to interact with your web application as if from a browser (in fact it is a browser). You can read more about Cypress here.

This ckan-integration-tests library provides you with a suite of pre-existing methods that you can use to speed up testing your CKAN-based data management system or portal.

Here we are going to walk you through setting up some automated functional tests for your site using this library.

1. Create a basic Cypress setup

First, let's start by creating a regular Cypress repository (?? what is the repository). TODO link instructions.

TODO: recommend where this to be located e.g. in a separate git repo or next to your existing code?

2. Create a test.js file to wrap-up your Cypress call

...

TODO:

  • Explain how to choose which tests you run from ckan-integration-tests
  • Explain how to create a new test but using existing fixtures from ckan-integration-tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants