A set of extensions to puppetlabs_spec_helper and rspec-puppet, for monolithic spaghetti puppet repos
Puppet is integral to Box's infrastructure and serves many purposes. Use of Puppet grew organically, resulting in a large monolith of fragile spaghetti code. When we realized we needed CI, this code was already in a very untestable state. Out of the box, rspec-puppet + puppetlabs_spec_helper did not work for us. Rather than continuing to rely only on manual testing or rewriting all our code into proper modules, roles, and profiles, we were able to make the unit testing system work with our spaghetti code.
This project includes all of the supporting code we wrote to extend rspec-puppet, in order to make unit testing work seamlessly with our Puppet codebase.
Users should be able to take this code and use it to bring unit testing to their monolithic spaghetti repos. We hope this helps others set up their testing infrastructure in a fraction of the time it took us.
https://github.com/jmoldow/box_spec_helper
These files all go into the root directory of your puppet control repo.
Create spec tests in spec/classes/, spec/defines/, and spec/functions/.
Run tests with any of the following commands:
-
rake spec
- Run all tests
-
rake spec SPEC=spec/classes/foo
- Run all tests in a directory
-
rake spec SPEC=spec/classes/foo/init_spec.rb
- Run all tests in a file
-
rake spec SPEC=spec/*/foo/
- Run all tests that match a path glob
Or use box/clusterrunner to deploy ClusterRunner and execute your test suite across a pool of machines (sample clusterrunner.yaml file provided in this repository).
More blog posts comming soon. Stay tuned to https://www.box.com/blog/engineering/.
- https://cloud.box.com/s/aeqhi3obhmu8yghi6w5xad31yt9fwcx5
- Draft slides for PuppetConf talk proposal.
-
puppetlabs_spec_helper
-
rspec-puppet
-
rspec
-
puppet
-
box/clusterrunner
The list of contributors can be found in AUTHORS.md and on Github.
Need to contact us directly? Email oss@box.com and be sure to include the name of this project in the subject. For questions, please contact us directly rather than opening an issue.
Feel free to contact the author at jmoldow@alum.mit.edu.
This project is not yet ready for external contributions.
The plan is to try upstreaming pieces of this project into the appropriate libraries, and create one or more Ruby gems for the rest of the project. The repositories for those Ruby gems would be open for contributions, subject to the Box Contributor License Agreement (CLA) and the Box Open Code of Conduct.
Copyright 2016 Box, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Some Apache v2.0 and MIT Expat-licensed code from 3rd party sources is included in this repository. See the bottom of the LICENSE file for details.