rbuisson / openmrs-test-3refapp

QA Dashboard for RefApp 3.x: Project Status

---

RefApp 3.x E2E tests

3.x RefApp Workflow Tests
3.x Demo Build

---

Setting up the project

This repository is a monorepo containing two different test projects which leverage two different test frameworks: Cypress and Playwright. The reason for the split is that Cypress, at the time of writing this, has a known issue that prevents testing the offline features that have been introduced to the OpenMRS frontend. The Playwright framework supports offline mode. Therefore, we use Playwright to write offline related E2E tests.

To do the basic repository setup:

1. Clone the project

    git clone [email protected]:openmrs/openmrs-test-3refapp.git
    cd openmrs-test-3refapp
   

2. Install the dependencies

   yarn install
   

At this point, you can continue with either the Cypress or the Playwright project. You can find more details about these two projects here:

• Cypress: README
• Playwright: README

Docker

Run the local instance

1. Checkout to docker directory

   cd docker
   

2. Run the app

   docker-compose -f docker-compose-refqa-3x.yml up
   

If the docker container doesn't work you have to set up the local instance by packaging.

Follow this steps for setting up the local instance

1. Clone the repository

   git clone -b 3.x [email protected]:openmrs/openmrs-distro-referenceapplication.git
   

2. Follow the instruction provided by the readme

• If the build fails, try deleting existing containers

  docker compose down -v
  

Creating a GitHub workflow

1. Create a new GitHub workflow file under .github/workflows/ directory. An example workflow can be found here.
2. Add the workflow badge to the readme file under 3.x RefApp section. It should take the following format:

   [![<workflow name>](<link-to-the-workflow>/badge.svg)](<link-to-the-workflow>)

Before Releasing

• For the platform, manually run both Installation and upgrade workflows again.
• Check all relevant builds to the release above to be sure they pass

Wiki

• We use JIRA to track issues and monitor project development. Refer to this link to view all issues and project summary: QA Kanban board JIRA.

• To get started contributing, start working on introductory issues in JIRA and check out OpenMRS Pull Request Tips.

• There is a detailed guide for setting up the OpenMRS QA Framework locally, checkout the guide here.