(BKR-1485) Update documentation #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This one doesn't actually need unit tests. |
Thoroughly document acceptance testing environment configuration. [skip ci]
kevpl
suggested changes
Jun 27, 2018
README.md
Outdated
| We run beaker's base acceptance tests with this library to see if the hypervisor is working with beaker. Please refer to the setting up [vmware fusion](vmware_fusion.md) docs to setup your hosts for testing and modify the [test-nodes hosts](acceptance/config/nodes/test-nodes.yml) file. Once that's setup, there is a simple rake task to invoke acceptance test for the library: | ||
| ```bash | ||
| bundle exec rake test:acceptance | ||
| We run beaker's base acceptance tests with this library to see if the hypervisor is working with beaker. You can run the acceptance tests locally; see <acceptance_setup.md>. Once that's setup, there is a simple rake task to invoke acceptance test for the library: |
There was a problem hiding this comment.
<acceptance_setup.md> doesn't appear to work when I view this page rendered. Does it need to change?
docs/acceptance_setup.md
Outdated
|
|
||
| These instructions cover provisioning a Ubuntu 16.04 VM: | ||
|
|
||
| 1. Download a Ubuntu 16.04 64-bit ISO. |
There was a problem hiding this comment.
unnecessary, but it would be cool to link out to Ubuntu's downloads page here
docs/acceptance_setup.md
Outdated
| These instructions cover provisioning the two testing VMs with a new public key for SSH access. We need two instances of the base VM, `beaker-ubuntu-1604-64` and `beaker-ubuntu-1604-64-2`: | ||
|
|
||
| 1. You can use the base VM configuration as the first SUT to save space. | ||
| 2. Configure a static IP for the VM. See <fusion_static_ip.md>. |
There was a problem hiding this comment.
looks like this has the same problem as above (link broken)
docs/acceptance_setup.md
Outdated
|
|
||
| Although originally written for VMWare Fusion 3.x, the Ruby Gem Fission which we use to configure VMWare Fusion VMs appears to work just fine with 10.x. All that is required is changing the local configuration to point to the CLI tools and VM datastore. Create `~/.fissionrc`: | ||
|
|
||
| ~~~yaml |
There was a problem hiding this comment.
this block doesn't render properly. Should these be backticks rather than tilde's?
kevpl
suggested changes
Jul 2, 2018
docs/acceptance_setup.md
Outdated
| ~~~console | ||
| $ ssh root@beaker-ubuntu.local | ||
| ~~~ | ||
| 5. Create a new snapshot (of the running VM) in VMWare Fusion: with the VM selected, Virtual Machine > Snapshots... > Take Snapshot (Cmd-Shift-S). Name this new snapshot `clear-keys`. This snapshot name is used in [acceptance/config/nodes/hosts.yaml](acceptance/config/nodes/hosts.yaml); when beaker provisions a VMWare host it restores it to a specified snapshot. |
There was a problem hiding this comment.
@Dakta it appears hosts.yaml here doesn't exist yet. I'm seeing a test-nodes.yml file, is that what this should be referring to?
kevpl
suggested changes
Jul 13, 2018
docs/acceptance_setup.md
Outdated
| ~~~console | ||
| $ ssh root@beaker-ubuntu.local | ||
| ~~~ | ||
| 5. Create a new snapshot (of the running VM) in VMWare Fusion: with the VM selected, Virtual Machine > Snapshots... > Take Snapshot (Cmd-Shift-S). Name this new snapshot `clear-keys`. This snapshot name is used in [acceptance/config/nodes/test-nodes.yml](acceptance/config/nodes/test-nodes.yml); when beaker provisions a VMWare host it restores it to a specified snapshot. |
There was a problem hiding this comment.
still broken. I suspect that adding a / to the beginning of the link might fix the issue. Looks like the relative link will include the docs folder since it's where this doc lives, which breaks the hosts file URL.
kevpl
approved these changes
Jul 16, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thoroughly document acceptance testing environment configuration.