motoko 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8863037ff395360857c200013862b108d7a101ee7a939911ee30f3d24d7fcd08
+  data.tar.gz: 4aefa7a9fd5a9ed4573f39c15a823f486d876d4cd7fa6b21f6e39fc3ef91e67b
+SHA512:
+  metadata.gz: 9ba38d76902c83f1edbfcb344668610fe5d57aa842e5e64ac93daddc9cb9031a9bfdf763931f07ee5c8d70e4e1cc40bc4533bbead7ef65800f450f98db5bdd01
+  data.tar.gz: 1be988997f339b9fada99d3118d643e752deedc509089665871069d5be6691aa0a5ca885002eb26ad9cc667149838dbc9d7aeb72f834b165ed4e9b5b04401272

data/.github/workflows/ci.yaml

@@ -0,0 +1,41 @@
+---
+name: "CI"
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  rubocop:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "3.0"
+          bundler-cache: true
+      - name: "Run rubocop"
+        run: "bundle exec rubocop"
+  test:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        ruby-version:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+    steps:
+      - uses: "actions/checkout@v2"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: "Run the test suite"
+        run: "bundle exec rake"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+---
+require:
+  - "rubocop-rake"
+  - "rubocop-rspec"
+AllCops:
+  NewCops: "enable"
+  TargetRubyVersion: "2.5"
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: "table"
+Layout/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
+Style/Documentation:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: "comma"
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: "comma"
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: "comma"

data/.simplecov

@@ -0,0 +1,10 @@
+# vim:set filetype=ruby:
+# frozen_string_literal: true
+
+SimpleCov.start do
+  add_filter '/spec/'
+
+  add_group 'Formatters', '/lib/motoko/formatters/'
+  add_group 'Resolvers',  '/lib/motoko/resolvers/'
+  add_group 'Utils',      '/lib/motoko/utils/'
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romain@blogreen.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inventory.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'simplecov'
+gem 'timecop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Romain Tartière
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,183 @@
+# Motoko
+
+A gem to get inventories of nodes in a Puppet / Choria deployment.
+
+## Installation
+
+Take care to install this tool in the Puppet envrionment.  If you are using the AIO package, you can install with:
+
+```
+/opt/puppetlabs/puppet/bin/gem install --bindir /opt/puppetlabs/bin puppetdb_cli
+```
+
+Alternatively, you can install using Puppet:
+
+```puppet
+package { 'motoko':
+  ensure   => installed,
+  provider => 'puppet_gem',
+}
+```
+
+## Usage
+
+Two inventroy scripts are currently provided:
+
+* `exe/inventory` use Choria discovery and return live data from your infrastructure;
+* `exe/pdb-inventory` use PuppetDB querying and return what Puppet thinks about your infrastructure.
+
+Both have a similar feature-set, and a full list of available options can be obtained by running them with `--help`.
+
+### Basic usage
+
+#### Which nodes are currently up and running
+
+```sh-session
+romain@zappy ~ % inventory
+```
+
+#### Which nodes are known to puppet
+
+```sh-session
+romain@zappy ~ % pdb-inventory
+```
+
+### Accessing facts
+
+By default, the report display the node name, along with it's `customer` and `role` facts (if these facts are available).  You can request additional facts are just replace the list.  The syntax is the same for both the choria and puppetdb inventory scripts.
+
+#### Add more facts to the output
+
+```sh-session
+romain@zappy ~ % inventory -a datacenter,city,country
+```
+
+### Filtering
+
+The usual filtering knobs are available for the choria inventory script.  The puppetdb inventory script has a minimal support for choria-like filtering.
+
+#### Which nodes have burned in Strasbourg
+
+The initial work on querying PuppetDB is due to the fact that you can't ask Choria for information about nodes which are gone.  On March 9th 2021, [OVH lost (part of) it's Strasboug datacenter](https://twitter.com/olesovhcom/status/1369478732247932929?ref_src=twsrc%5Etfw) and the frustration of not being able to conviniently build a list of affected nodes and customers was a pain. with motoko we can now just query PuppetDB:
+
+```sh-session
+romain@zappy ~ % pdb-inventory -F datacenter=/sbg/
+```
+## Configuration
+
+At startup, Motoko will load system-wide configuration from `/etc/motoko/config.yaml`, and then user configuration from `~/.config/motoko/config.yaml`.
+
+### Columns
+
+Set the list of columns to display by default:
+
+```yaml
+columns:
+  - "host"
+  - "customer"
+  - "role"
+  - "country"
+  - "city"
+```
+
+### Column Specifications
+
+Customize how columns are displayed:
+
+* `human_name`: what title should be used for the column (defaults to a capitalized version of the column name);
+* `resolver`: which [resolver](#resolvers) to use to gather the information (defaults to `fact`);
+* `formatter`: which [formatter](#formatters) to use to print the value (none by default);
+* `align`: how to align the formatted value in the column (default to `left`).
+
+```yaml
+columns_spec:
+  host:
+    resolver: "identity"
+  customer:
+    formatter: "ellipsis"
+    max_length: 20
+  cpu:
+    resolver: "cpu"
+  os:
+    human_name: "Operating System"
+    resolver: "os"
+  reboot_required:
+    human_name: "R"
+    resolver: "reboot_required"
+    formatter: "boolean"
+```
+
+### Shortcuts
+
+```yaml
+shortcuts:
+  dc:
+    description: "Show physical node locations"
+    add_columns:
+      - "datacenter"
+      - "server_rack"
+      - "server_id"
+    with_fact:
+      - "virtual=physical"
+```
+
+This add a new command switch `--dc` equivalent to `--add-columns datacenter,server_rack,server_id --with-fact virtual=physical`.
+
+## Resolvers
+
+| Resolver name     | Desciption |
+|-------------------|------------|
+| `cpu`             | Aggregate information about the CPU |
+| `fact`            | Gather the value of the fact `fact` (default to the column name if unset) |
+| `identity`        | Gather the node identity |
+| `os`              | Aggregate information about the OS |
+| `reboot_required` | Combine value of various facts to determine if a reboot is required |
+
+### Extending Motoko with custom resolvers
+
+Custom resolvers can be droped in the `<motoko-config-directory>/resolvers/` directory.  They are automatically loaded on startup.
+
+## Formatters
+
+| Formatter name  | Desciption |
+|-----------------|------------|
+| `boolean`       | Display a checkmark for things that evaluate to `true` |
+| `datetime`      | Display a date and time in the local time zone |
+| `datetime_ago`  | Display a date and time as a duration |
+| `ellipsis`      | Display a value truncated at `max_length` chars (default: 20) |
+| `timestamp`     | Display a timestamp (number of seconds since the Unix epoch) in the local time zone |
+| `timestamp_ago` | Display a timestamp (number of seconds since the Unix epoch) as a duration |
+
+### Extending Motoko with custom formatters
+
+Custom formatters can be droped in the `<motoko-config-directory>/formatters/` directory.  They are automatically loaded on startup.
+
+## Development
+
+In order to use the Puppet environment, use the version of bundler bundled with Puppet:
+
+```
+/opt/puppetlabs/puppet/bin/bundle install
+/opt/puppetlabs/puppet/bin/bundle exec rake spec
+/opt/puppetlabs/puppet/bin/bundle exec exe/inventory
+```
+
+Iy you want to install this development code:
+
+```
+/opt/puppetlabs/puppet/bin/gem build motoko.gemspec
+sudo /opt/puppetlabs/puppet/bin/gem install --bindir /opt/puppetlabs/bin motoko-x.y.z.gem
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smortex/motoko. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/smortex/motoko/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Motoko project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/smortex/motoko/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'inventory'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here