Skip to content

Commit

Permalink
Merge pull request #1870 from cnti-testcatalog/github_runner_updates
Browse files Browse the repository at this point in the history
Testsuite Repo URL Migration and Github Runner Updates
  • Loading branch information
HashNuke authored Feb 27, 2024
2 parents e54218b + 8ce3b4e commit 33a2bac
Show file tree
Hide file tree
Showing 22 changed files with 154 additions and 139 deletions.
10 changes: 5 additions & 5 deletions CNF_TESTSUITE_YML_USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The cnf-testsuite.yml is used by `cnf_setup` in order to install the CNF to be tested onto an existing K8s cluster.


The information in the cnf-testsuite.yml is also used for additional configuration of some tests e.g. `allowlist_helm_chart_container_names` is used for exculding containers from the [privileged](https://github.com/cncf/cnf-testsuite/blob/main/src/tasks/workload/security.cr#L196) container test.
The information in the cnf-testsuite.yml is also used for additional configuration of some tests e.g. `allowlist_helm_chart_container_names` is used for exculding containers from the [privileged](https://github.com/cnti-testcatalog/testsuite/blob/main/src/tasks/workload/security.cr#L196) container test.


### Table of Contents
Expand All @@ -16,7 +16,7 @@ The information in the cnf-testsuite.yml is also used for additional configurati

### Overview of all cnf-testsuite.yml

The following is a basic working example cnf-testsuite.yml file that can be found in the cnf-testsuite respository: [cnf-testsuite.example.yml](https://github.com/cncf/cnf-testsuite/blob/CNF_TESTSUITE_YML%231357/example-cnfs/coredns/cnf-testsuite.yml)
The following is a basic working example cnf-testsuite.yml file that can be found in the cnf-testsuite respository: [cnf-testsuite.example.yml](https://github.com/cnti-testcatalog/testsuite/blob/CNF_TESTSUITE_YML%231357/example-cnfs/coredns/cnf-testsuite.yml)

```yaml=
---
Expand Down Expand Up @@ -94,7 +94,7 @@ This is the path to the helm chart directory (relative to the location of the cn

An example of a helm directory can be found [here](https://github.com/helm/charts/tree/master/stable/coredns).

The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_coredns/cnf-testsuite.yml` and helm_directory is set to `helm_directory: chart` the test suite would expect to find the chart under [`sample-cnfs/sample_coredns/chart`](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_coredns/chart)
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_coredns/cnf-testsuite.yml` and helm_directory is set to `helm_directory: chart` the test suite would expect to find the chart under [`sample-cnfs/sample_coredns/chart`](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_coredns/chart)

Example Setting:

Expand All @@ -117,9 +117,9 @@ Example Setting:
This is the path to a directory of manifest files for installing the cnf (relative to the location of the cnf-testsuite.yml). This, or [helm_chart](#helm_chart), or [helm_directory](#helm_directory) must be set, but only one **(mutually exclusive)**. This argument is used by cnf_setup in order to deploy the CNF being tested onto an existing K8s cluster.


An example of a manifest directory can be found [here](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_nonroot/manifests).
An example of a manifest directory can be found [here](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_nonroot/manifests).

The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_nonroot/cnf-testsuite.yml` and manifest_directory is set to `manifest_directory: manifests` the test suite would expect to find the manifest files under [`sample-cnfs/sample_nonroot/manifests`](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_nonroot/manifests)
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_nonroot/cnf-testsuite.yml` and manifest_directory is set to `manifest_directory: manifests` the test suite would expect to find the manifest files under [`sample-cnfs/sample_nonroot/manifests`](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_nonroot/manifests)

Example Setting:

Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Issues are used as the primary method for tracking items in the CNF Test Suite i
### Issue Templates

**1. New Features:**
To request an enhancement, please create a new issue using the [**Feature Request**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) Template
To request an enhancement, please create a new issue using the [**Feature Request**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) Template

**2. Report Bugs:**
To report a bug, please create a new issue using the [**Bug Report**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) Template. Check out [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html.).
To report a bug, please create a new issue using the [**Bug Report**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) Template. Check out [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html.).

NOTE: To help with debugging, you can enable higher logging level output via the command line or env var

Expand All @@ -55,11 +55,11 @@ Check [usage documentation](USAGE.md) for more info about invoking commands and

**3. New CNF Test Suite Tests:**

- To request a new workload test, please create a new issue using the [**New Workload Test**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) Template
- To request a new platform test, please create a new issue using the [**New Platform Test**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) Template
- To request a new workload test, please create a new issue using the [**New Workload Test**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) Template
- To request a new platform test, please create a new issue using the [**New Platform Test**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) Template

**4. New CNF Example:**
To suggest a new CNF, please create a GitHub issue using the [New Example CNF template](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=example+CNF&template=new-example-cnf.md&title=%5BCNF%5D).
To suggest a new CNF, please create a GitHub issue using the [New Example CNF template](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=example+CNF&template=new-example-cnf.md&title=%5BCNF%5D).

To install the CNF Test Suite and run a CNF, follow instructions at:

Expand All @@ -75,7 +75,7 @@ The test framework and tests (using upstream tools) are written in the human rea

Outline of what a contributor's workflow looks like:

1. Fork it (https://github.com/cncf/cnf-testsuite/fork)
1. Fork it (https://github.com/cnti-testcatalog/testsuite/fork)
1. Create a branch from where you want to base your work (usually main). Example `git checkout -b my-new-feature)`
1. Read the [INSTALL.md](install for build and test instructions)
1. Make your changes and arrange them in readable commits.
Expand Down Expand Up @@ -109,7 +109,7 @@ For general advice on how to submit a pull request, please see [Creating a pull
`git clone [email protected]:<contributor-username>/cnf-testsuite.git`
`cd cnf-testsuite`
3. Add the original cnf-testsuite repo.
`git remote add cncf [email protected]:cncf/cnf-testsuite.git`
`git remote add cncf [email protected]:cnti-testcatalog/testsuite.git`
4. Checkout the pull request's branch.
`git checkout <pull-request's-branch-name>`
5. Push the branch to the original cnf-testsuite repo.
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTION_LADDER.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ How you can learn more?

* Read the [install guide](INSTALL.md), [usage guide](USAGE.md), [FAQ](FAQ.md), and other documentation
* Request a live demonstration and introduction of the test suite ([book a time on Calendly](https://calendly.com/cnftestsuite))
* Come chat with us in [Slack](https://cloud-native.slack.com/archives/C014TNCEX8R) or start a [discussion](https://github.com/cncf/cnf-testsuite/discussions)
* Come chat with us in [Slack](https://cloud-native.slack.com/archives/C014TNCEX8R) or start a [discussion](https://github.com/cnti-testcataglog/testsuite/discussions)

## Community Participant

Expand All @@ -40,7 +40,7 @@ How you can be more involved and participate in the community:
* Helping other users
* Commenting on issues
* Trying out new releases
* Attending [community meetings](https://github.com/cncf/cnf-testsuite#communication-and-community-meetings) and events
* Attending [community meetings](https://github.com/cnti-testcatalog/testsuite#communication-and-community-meetings) and events

## Contributor

Expand Down
2 changes: 1 addition & 1 deletion EXAMPLE-CNFS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is a preliminary list of CNF samples for each layer in the [OSI model](http

## [Layer 7 - Application](https://en.wikipedia.org/wiki/Application_layer)

- [CoreDNS Sample CNF](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample-coredns-cnf)
- [CoreDNS Sample CNF](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample-coredns-cnf)
- [NFF Go Deep Packet Inspection example](https://github.com/intel-go/nff-go/tree/master/examples/dpi) example

## [Layer 6 - Presentation](https://en.wikipedia.org/wiki/Presentation_layer)
Expand Down
8 changes: 4 additions & 4 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,23 @@
<details> <summary>If I found a bug or I think it's a bug, how do I report it?</summary>
<p>

- If you would like to report a bug, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) (using the **Bug Report** Template).
- If you would like to report a bug, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) (using the **Bug Report** Template).

</p>
</details>

<details> <summary>How do I request a new feature?</summary>
<p>

- If you would like to request an enhancement, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) (using the **Feature Request** Template).
- If you would like to request an enhancement, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) (using the **Feature Request** Template).

</p>
</details>

<details> <summary>Can I request a new workload or platform test for the CNF Test Suite?</summary>
<p>

- Yes. If you would like to request a new workload test, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) (using the **New Workload Test** Template) or create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) (using the **New Platform Test** Template).
- Yes. If you would like to request a new workload test, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) (using the **New Workload Test** Template) or create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) (using the **New Platform Test** Template).

</p>
</details>
Expand All @@ -79,7 +79,7 @@
<details> <summary>How are points assigned for tests?</summary>
<p>

- Points are different for each test and workload but in general terms, pass defaults to 5 and fail is a -1. See [points.yml](https://github.com/cncf/cnf-testsuite/blob/main/embedded_files/points.yml) for more details on the different points for default scoring.
- Points are different for each test and workload but in general terms, pass defaults to 5 and fail is a -1. See [points.yml](https://github.com/cnti-testcatalog/testsuite/blob/main/embedded_files/points.yml) for more details on the different points for default scoring.

</p>
</details>
Expand Down
14 changes: 7 additions & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ cd tools/ && git clone https://github.com/crosscloudci/k8s-infra.git
We support the following methods of installing the cnf-testsuite:

- [Curl installation](#Curl-Binary-Installation) (via latest binary release)
- [Latest Binary](https://github.com/cncf/cnf-testsuite/releases/latest) (manual download)
- [Latest Binary](https://github.com/cnti-testcatalog/testsuite/releases/latest) (manual download)
- From [**Source**](#Source-Install) on github.
- [Air Gapped](#Air-Gapped)

Expand All @@ -88,20 +88,20 @@ There are two methods to install via curl, we prefer the first method (the other
- This first command using curl will download, install, and export the path automatically (recommended method):

```
source <(curl -s https://raw.githubusercontent.com/cncf/cnf-testsuite/main/curl_install.sh)
source <(curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh)
```

<details><summary>Click here for the alternate curl and manual install method</summary>
<p>

- The other curl method to download and install requires you to export the PATH to the location of the executable:
```
curl -s https://raw.githubusercontent.com/cncf/cnf-testsuite/main/curl_install.sh | bash
curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh | bash
```

- The Latest Binary (or you can select a previous release if desired) can be pulled down with wget, curl or you're own preferred method. Once downloaded you'll need to make the binary executable and manually add to your path:
```
wget https://github.com/cncf/cnf-testsuite/releases/download/latest/latest.tar.gz
wget https://github.com/cnti-testcatalog/testsuite/releases/download/latest/latest.tar.gz
tar xzf latest.tar.gz
cd cnf-testsuite
chmod +x cnf-testsuite
Expand All @@ -120,7 +120,7 @@ This is a brief summary for source installations and [does have requirements](#R
Follow these steps to checkout the source from github and compile a cnf-testsuite binary:

```
git clone https://github.com/cncf/cnf-testsuite.git
git clone https://github.com/cnti-testcatalog/testsuite.git
cd cnf-testsuite/
shards install
crystal build src/cnf-testsuite.cr
Expand Down Expand Up @@ -209,14 +209,14 @@ Now cnf-testsuite is setup, we're ready to configure it to point at a CNF to tes
- If you want to use an example CNF, you can download our CoreDNS example CNF by doing the following:

```
wget -O cnf-testsuite.yml https://raw.githubusercontent.com/cncf/cnf-testsuite/main/example-cnfs/coredns/cnf-testsuite.yml
wget -O cnf-testsuite.yml https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/example-cnfs/coredns/cnf-testsuite.yml
```
- The wget gets a working config file, now tell cnf-testsuite to use it by doing the following:
```
cnf-testsuite cnf_setup cnf-config=./cnf-testsuite.yml
```

- There are other examples in the [examples-cnfs](https://github.com/cncf/cnf-testsuite/tree/master/example-cnfs) directory that can be used for testing as well.
- There are other examples in the [examples-cnfs](https://github.com/cnti-testcatalog/testsuite/tree/master/example-cnfs) directory that can be used for testing as well.

#### Bring Your Own CNF

Expand Down
2 changes: 1 addition & 1 deletion KIND-INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ for node in $(kind get nodes); do
done
```

Now you can use CNFs that require Multus and CNIs, e.g. [examples/ip-forwarder](https://github.com/cncf/cnf-testsuite/tree/main/example-cnfs/ip-forwarder)
Now you can use CNFs that require Multus and CNIs, e.g. [examples/ip-forwarder](https://github.com/cnti-testcatalog/testsuite/tree/main/example-cnfs/ip-forwarder)
Loading

0 comments on commit 33a2bac

Please sign in to comment.