Skip to content

Commit da1f312

Browse files
authored
Merge pull request #74 from olhado/fixes
Update docs and remove unused file
2 parents 76ebaff + c1f872f commit da1f312

File tree

4 files changed

+7
-121
lines changed

4 files changed

+7
-121
lines changed

.kitchen.ec2.yml

Lines changed: 0 additions & 102 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ We encourage anyone to provide enchancements/fixes to this repository. Simply fo
77
### What makes a good PR?
88

99
* Make sure you update the README.md with any new/removed/changed values parameters.
10-
* Write tests that cover your proposed changes.
10+
* Write tests that cover your proposed changes. (See the [TESTING](TESTING.md) documentation)
1111
* Make sure the tests documented in the [README](README.md) run as expected on all platforms.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The following Opscode cookbooks are dependencies:
3232
* `apt`
3333
* `yum`
3434

35-
3635
Recipes
3736
=======
3837

TESTING.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,36 +30,25 @@ bundle exec rake
3030

3131
### Integration Tests
3232

33-
This tests a number of different suites, some of which require special credentials or virtual machine configurations.
34-
Integration tests are setup to run under test-kitchen:
33+
This tests a number of different integration test suites using docker containers. They are
34+
setup to run under test-kitchen:
3535

3636
Requirements:
3737
To run integration testing you need a valid threatstack agent deployment key
3838
Get your deployment key from the Threat Stack application under "Settings" -> "Applications Keys"
3939

40+
**Example:**
4041
```
4142
export TS_DEPLOY_KEY=<deploy key>
4243
export TS_CONFIG_ARGS=['fim.log yes']
4344
```
4445

45-
Vagrant/local integration testing
46+
Local container integration testing
4647
---------------
47-
Vagrant testing through the Kitchen-CI toolset can be done locally. You must have VirtualBox and vagrant installed.
48+
Container (with docker) testing through the Kitchen-CI toolset can be done locally. You must have
49+
docker installed. The `.kitchen.yml` file drives the configuration and execution of the tests.
4850

4951
To run tests, use the kitchen framework. The following will run all tests:
5052
```
5153
bundle exec kitchen test
5254
```
53-
54-
Using ec2 nodes through vagrant
55-
----------------------------------------
56-
This approach to integration testing will allow you to use custom nodes, or cloud-specific nodes. (The most common case is Amazon Linux 1 and 2).
57-
58-
To test using ec2 instead of VirtualBox nodes, use the `.kitchen.ec2.yml` configuration file. You may need additional environment variables set for those tests (such as `AWS_SECRET_ACCESS_KEY`, `AWS_ACCESS_KEY_ID`, `AWS_SSH_KEY`, `SG_GROUP_IDS`, `SG_SUBNET_ID`, or `IMAGE_OWNER_ID`.
59-
60-
You may not need all of those, but you likely need the AWS- ones for native kitchen-ec2 provisioning.
61-
62-
To run tests on the EC2 kitchen file, run commands as follows:
63-
```
64-
KITCHEN_YAML=".kitchen.ec2.yml" bundle exec kitchen test
65-
```

0 commit comments

Comments
 (0)