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

Update doc for integration test #166

Merged
merged 1 commit into from
Jan 7, 2019
Merged

Update doc for integration test #166

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
23 changes: 8 additions & 15 deletions tests/integration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
## Integration Testing
Integration test verifies the functionality of EBS CSI driver as a standalone server outside Kubernetes. It exercises the lifecycle of the volume by creating, attaching, staging, mounting volumes and the reverse operations. And it verifies data can be written onto an EBS volume without any issue.

### Requirements
## Run Integration Tests Locally
The integration test is executed using [aws-k8s-tester](https://github.com/aws/aws-k8s-tester) which is CLI tool for k8s testing on AWS. With aws-k8s-tester, it automates the process of provisioning EC2 instance, pulling down and building EBS CSI driver, running the defined integration test and sending test result back. See aws-k8s-tester for more details about how to use it.

1. macOS or Linux
1. `GOPATH` environment variable [set](https://github.com/golang/go/wiki/SettingGOPATH)
1. [AWS account](https://aws.amazon.com/account/) that has been [configured locally](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
### Requirements
1. AWS credential is [configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
1. Other requirements needed by aws-k8s-tester
Copy link
Member

Choose a reason for hiding this comment

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

Maybe a link for aws-k8s-tester requirements would be nice (if there's any)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There isn't any yet. Created an issue to track this: aws/aws-k8s-tester#32


Must satisfy also the requirements for `aws-ebs-csi-driver`

### Run Integration Tests Locally

```bash
```
make test-integration
```

#### Overriding Defaults
- The master branch of `aws-ebs-csi-driver` is used by default. To run using a pull request for `aws-ebs-csi-driver`, set `PULL_NUMBER` as an environment variable with a value equal to the pull request number.

- When the tests are run, a new VPC is created by default. To run using an existing VPC, set `AWS_K8S_TESTER_VPC_ID` as an environment variable with a value equal to an existing VPC ID.

### Additional Information

- GitHub [repo](https://github.com/aws/aws-k8s-tester) for `aws-k8s-tester`, which includes information about releases and running locally
- Kubernetes Enhancement Proposal ([KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-aws/20181126-aws-k8s-tester.md)) for `aws-k8s-tester`
- When the tests are run, a new Amazon Virtual Private Cloud (VPC) is created by default. To run using an existing VPC, set `AWS_K8S_TESTER_VPC_ID` as an environment variable with a value equal to an existing VPC ID. This will be useful when VPC limit is reached in the region under test.