1. Operating system (typically Fedora or MacOS)
2. Install Node.js 20 or above (OS native packages, or nodejs, or nvm managed installs are all ok)

1. Clone automation repository and setup

   git clone https://github.com/konveyor/tackle-ui-tests.git
   cd tackle-ui-tests
   npm clean-install

2. Open Cypress and run test cases

   npx cypress open

Some tests require certain configuration parameters to be correctly defined in the cypress.config.ts file. Below is a list of tests and the parameters they require.

• export_to_jira_datacenter.test.ts

  • jira_stage_datacenter_project_id
  • jira_stage_bearer_token
  • jira_stage_datacenter_url

• export_to_jira_cloud.test.ts

  • jira_atlassian_cloud_project
  • jira_atlassian_cloud_email
  • jira_atlassian_cloud_token
  • jira_atlassian_cloud_url

• source_analysis.test.ts and binary_analysis.test.ts

  • git_user
  • git_password

Husky and lint-staged are used to format staged files when committing.

To manually format the cypress code: npm run format

To manually check the code formatting: npm run check

1. Update Pull request with upstream main branch
2. Pull requests will be tested against environment before merging to main codebase
3. Pull request's owner must add RFR label once pull request is ready to test against environment
4. After adding RFR label, the PR owner should force push the pull request to trigger GitHub action
5. In some cases, the reviewer wants to trigger the PR test GH action but they can't force push to the PR branch. Hence added feature of triggering GH action manually. Steps to trigger GH action for PR testing manually:
   • Go to Actions tab
   • Click on GH action(Pull request test)
   • Click on run workflow dropdown
   • select PR branch
   • Click on button Run workflow

1. Click here to see Old test runs - run1, run2, run3

2. Click here to see Current test runs

This repository uses the package cypress-tags to slice up test runs.

1. To run tests based on tags, use below command

   CYPRESS_INCLUDE_TAGS=@tagName npx cypress run

2. To run multiple tags(tiers) in a single run, provide tag names separated by commas

   CYPRESS_INCLUDE_TAGS=@tier1,@tier2 npx cypress run

1. Install minikube on your local machine by referring to docs

2. Setup recommended minikube configurations and start minikube with the ingress addon

   minikube config set memory 10240
   minikube config set cpus 4
   minikube start --addons=ingress

3. Install kubectl if needed, or substitute minikube kubectl -- for all kubectl commands.

4. Install OLM manually

   curl -L https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.28.0/install.sh -o install.sh
   chmod +x install.sh
   ./install.sh v0.28.0

5. Install the Konveyor operator (operator install) to the default namespace konveyor-tackle

   kubectl apply -f https://raw.githubusercontent.com/konveyor/operator/main/tackle-k8s.yaml

6. Create a Tackle CR (setting the spec values as needed)

   cat << EOF | kubectl apply -f -
   kind: Tackle
   apiVersion: tackle.konveyor.io/v1alpha1
   metadata:
     name: tackle
     namespace: konveyor-tackle
   spec:
     feature_auth_required: false
   EOF

7. Wait for the tackle ingress to become available

   kubectl wait -n konveyor-tackle ingress/tackle --for=jsonpath='{.status.loadBalancer.ingress[0]}' --timeout=600s

8. Once the Konveyor UI ingress is running, tests can be run against this local instance, with video captures of the tests turned on, using the command

   CYPRESS_baseUrl=https://$(minikube ip) npx cypress run --config video=true

Tests are tagged for selective execution based on purpose, stability, and resource requirements.

Use the findTierFiles.js utility to locate and run tests with specific tags:

# Find all tier0 tests
node cypress/scripts/findTierFiles.js tier0

# Run tests for a specific tier
npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier0)"

# Run tests for multiple tiers
npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier0,interop)"

• Purpose: Runs on minikube for PR validation via Konveyor CI
• Constraints:
  • Limited resources (minikube environment)
  • Cannot use tests requiring external credentials
  • Time-constrained (must complete reasonably quickly)
• Tests Include:
  • Login and navigation validation
  • Business service CRUD
  • Job function CRUD
  • Stakeholder, stakeholder group, tag, and archetype CRUD operations
  • Application assessment, review, and analysis with effort and issues validation

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js ci)"

• Purpose: Core smoke tests for critical functionality
• Runs on: Stage, production, and nightly on Konveyor CI
• Tests Include:
  • Custom migration targets CRUD and validation
  • Source analysis on bookserver app (without credentials)
  • Source + dependency analysis validation
  • Migration waves CRUD and application association

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier0)"

• Purpose: Comprehensive analysis tests requiring external credentials
• Runs on: Nightly on Konveyor CI
• Tests Include:
  • Binary analysis with Git credentials
  • Source code analysis with credentials
  • Node.js application analysis
  • Python application analysis
  • Upload binary analysis

Required Config: Tests need git_user and git_password configured in cypress.config.ts

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier1)"

• Purpose: Full CRUD coverage for all features
• Test Areas: Administration (credentials, repositories, questionnaires), application inventory, controls, custom metrics, migration waves, task manager, RBAC, and analysis features

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier2)"

• Purpose: Validate sorting, filtering, and UI interactions
• Tests Include:
  • Job function filters
  • Tag filters on application details
  • Manual package selection for analysis
  • Analysis with proxy configuration

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier3)"

• Purpose: Load testing and performance validation
• Tests Include:
  • Bulk analysis operations
  • Large dataset handling
  • Performance benchmarks

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier4)"

• Purpose: Used by interOp team for testing on ROSA, ROSA-STS, and ARO clusters
• Tests Include:
  • Source control credentials CRUD
  • Custom migration targets CRUD
  • Stakeholder CRUD operations

Usage:

npx cypress run --spec "$(node cypress/scripts/findTierFiles.js interop)"

To run tests from multiple tiers in a single execution:

# Run tier0 and tier1 together
npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier0,tier1)"

# Run interop and tier0 tests
npx cypress run --spec "$(node cypress/scripts/findTierFiles.js tier0,interop)"

To check if the license's header is available in all eligible files, execute:

yarn license-check-and-add check

To add the license's header to all eligible files, execute:

yarn license-check-and-add add

Refer to Konveyor's Code of Conduct here.