crc-org / crc

CRC is a tool to help you run containers. It manages a local OpenShift 4.x cluster, Microshift or a Podman VM optimized for testing and development purposes
https://crc.dev
Apache License 2.0
1.26k stars 242 forks source link

[DOC] Add clarification in Development documentation about running E2E Tests #4458

Open rohanKanojia opened 1 week ago

rohanKanojia commented 1 week ago

Description

Related to #4406

Current CRC Developing documentation isn't clear about how to run E2E tests. It specifies the flags that are supposed to be passed but doesn't specify the correct way of passing them.

Currently this is how E2E tests are prescribed to be run :

make e2e GODOG_OPTS="--godog.tags='@basic && @windows'" BUNDLE_LOCATION=<bundle location> PULL_SECRET_FILE=<pull secret path>

However, when I was trying to provide values in those variables, tests were not picking right bundle and pull secret file.

When I ran them by providing flags as well, it worked (notice how flags are specified again in cli form --bundle-location= inside env variable):

make e2e GODOG_OPTS="--godog.tags='@basic'" BUNDLE_LOCATION="--bundle-location=/home/rokumar/.crc/cache/crc_libvirt_4.17.0_amd64.crcbundle" PULL_SECRET_FILE="--pull-secret-file=/home/rokumar/Downloads/pull-secret.txt" CRC_BINARY="--crc-binary=/home/rokumar/go/bin/crc"

Expected Behavior

Development docs clearly describe how to run E2E tests.

Acceptance Criteria