chef / chef/effortless

[design-proposal] Add support for testing

Open
#57 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Design Proposal
Dominant language
Shell
Stars
35
Forks
35
Avg merge
2d 7h
Merged PRs (30d)
8

Description

The effortless pattern should support testing of the components and be included as a best practice.

Describe the problem

Currently when building out an effortless project testing is an exercise left up to the user. There should be a best practice decided on and included in this repository to improve this experience because it's pretty important to end users.

Software Version

N/a

Possible Solution

Currently when testing effortless packages we do the following:

  1. Build the habitat package
  2. Use kitchen-vagrant to create a VM(s) with the results directory synced
  3. Install the package on the VMs
  4. Run the inspec tests

Open to other suggestions!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing effortless package-testing workflow described in the issue: build the Habitat package, sync the results directory with kitchen-vagrant, install it on VMs, and run InSpec tests. Compare possible testing approaches and define a best practice for component testing that is documented and included in the repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
devops, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.