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.

Sign up for GitHub

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

Minor fixes in uptest integration guide. #49

Merged
merged 1 commit into from
Nov 28, 2022
Merged

Minor fixes in uptest integration guide. #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build
Open in desktop
Submodule build updated 4 files
+1 −1 makelib/controlplane.mk
+1 −7 makelib/golang.mk
+2 −0 makelib/k8s_tools.mk
+8 −0 makelib/local.xpkg.mk
13 changes: 9 additions & 4 deletions docs/integrating-uptest-for-e2e-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Integrating Uptest for End to End Testing

In this tutorial, we will integrate [uptest](https://github.com/upbound/uptest) to a Github repository to automate end to end
testing managed resources. While we will use a `Provider` repository as an example, the process will be identical for a
`Configuration` repository.
testing managed resources. While we will use a `Provider` repository as an example, the process will be almost identical
for a `Configuration` repository.

Starting with a provider repository with no end to end testing capability, we will end up having:
- A make target to locally test examples end to end
Expand All @@ -27,7 +27,7 @@ Starting with a provider repository with no end to end testing capability, we wi
touch cluster/test/setup.sh
chmod +x cluster/test/setup.sh

cat <<EOF > cluster/test/setup.sh
cat <<EOF0 > cluster/test/setup.sh
#!/usr/bin/env bash
set -aeuo pipefail

Expand Down Expand Up @@ -55,7 +55,8 @@ Starting with a provider repository with no end to end testing capability, we wi
name: provider-secret
namespace: upbound-system
key: credentials
EOF
EOF
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we also need this EOF?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is for the one at line 46.

EOF0
```

5. Now, please add the following lines to your Makefile which which will add `uptest` and `e2e` targets:
Expand All @@ -75,6 +76,10 @@ Starting with a provider repository with no end to end testing capability, we wi
e2e: build controlplane.up local.xpkg.deploy.provider.$(PROJECT_NAME) uptest
```

> Note: If you're following this tutorial for a `Configuration` repository, you will need to add
> `local.xpkg.deploy.configuration.$(PROJECT_NAME)` instead of `local.xpkg.deploy.provider.$(PROJECT_NAME)` to the
> `e2e` target.

6. Commit the changes we did so far.

```bash
Expand Down