chef/ohai

ohai

Description

Ohai detects data about your operating system. It can be used standalone, but its primary purpose is to provide node data to Chef.

Ohai will print out a JSON data blob for all the known data about your system. When used with Chef, that data is reported back via node attributes.

Chef distributes Ohai as a RubyGem. This README is for developers who want to modify the Ohai source code. For users who want to write plugins for Ohai, see the documentation:

• General documentation: https://docs.chef.io/ohai/
• Writing Ohai Plugins documentation: https://docs.chef.io/ohai_custom/

Development Environment

Ohai's development dependencies should be installed with bundler. Just run bundle install in the root of the repo.

Spec Testing

We use RSpec for unit/spec tests. To run the full suite, run:

bundle exec rake spec

You can run individual test files by running the rspec executable:

bundle exec rspec spec/unit/FILE.rb

Style

We use Cookstyle, as a code linter, to enforce style guidelines. To run:

bundle exec rake style

You can run and automatically correct the issues:

bundle exec rake style:auto_correct

Rake Tasks

Ohai has some Rake tasks for doing various things.

bundle exec rake -T
rake build               # Build ohai-$VERSION.gem into the pkg directory
rake clean               # Remove any temporary products
rake clobber             # Remove any generated files
rake install             # Build and install ohai-$VERSION.gem into system gems
rake install:local       # Build and install ohai-$VERSION.gem into system gems without network access
rake release[remote]     # Create tag $VERSION and build and push ohai-$VERSION.gem to rubygems.org
rake spec                # Run RSpec code examples
rake style               # Run Chefstyle tests
rake style:auto_correct  # Auto-correct RuboCop offenses

($VERSION is the current version, from the GemSpec in Rakefile)

Links

Source:

• https://github.com/chef/ohai/tree/main

Issues:

• https://github.com/chef/ohai/issues

Contributing

For information on contributing to this project see https://github.com/chef/chef/blob/main/CONTRIBUTING.md

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature' --signoff)
4. Run the tests bundle exec rake spec
5. Run the style tests bundle exec rake style
6. Push to the branch (git push origin my-new-feature)
7. Create new Pull Request

Auto-merge and required checks

This repository has GitHub auto-merge enabled. To help your PR merge quickly:

• Keep your branch up to date. GitHub may prompt you to update your PR branch; please do so to keep checks current.
• All checks must be green before auto-merge can complete. A workflow named allchecks verifies that every configured workflow has passed.
• Buildkite must be green. A required Buildkite check blocks merging if it is not successful.
• DCO is required. Ensure commits are signed off (use --signoff).

License

Ohai - system information application

• Author:: Adam Jacob ([email protected])
• License:: Apache License, Version 2.0

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.

Copyright

See COPYRIGHT.md.