vmfloaty 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259a0672eabcb43fbb7fddd8205341050ab60f902e7842cb520f81bab1f139eb
-  data.tar.gz: 22fdda03271053a921f305c6e547d09308d1d734bc77dfbd60bbbf47483e4137
+  metadata.gz: 5d8a0fcfd2e8fd42301c8a8c6ec14336444c5d70dda0adaed0731cbddcc90f7d
+  data.tar.gz: f3d5ef1252fbcb9142afba59d78f93d6cdbaaf76f11680a13c91654fbbc308fc
 SHA512:
-  metadata.gz: 3c0ca6bc4d734b7b0712001d7bd33b8b493cdf2e588712d422383631ef9a749f8b98964ff6a8b05dd2c4c465fb0726af3af88692bc4baa94278c546461614bc4
-  data.tar.gz: 072a4ab26891877393d3b70bc71d409b0a7dccd930bc6271fe6cf6bd7e16fe10e5fcd250b8313112afb9e8e9f25043c41d5173ad6bc0fb121d7e1f8255e74d4d
+  metadata.gz: 568f97d95dccec571488649670fb9fb8022ca58ec6a94c7b333d0f45d9f08ce4ff42c82cd8aef9bfc2079920b3178d333989d8422b68d2dfafe96fbaa08968c9
+  data.tar.gz: 7df48c34d04d7b6aaf4c6b4ac66fd845016c44519040192ddb2aa5d69f89043960d974a910cb1c8eceef6014d96f04891c71276ff5367760b0fa45ec5184aa88

data/README.md

@@ -1,37 +1,48 @@
 # vmfloaty
 
 [![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
-[![CI](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml)
+[![Test](https://github.com/puppetlabs/vmfloaty/actions/workflows/test.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/test.yml)
 
 A CLI helper tool for [Puppet's VMPooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
 
 ![float image](float.jpg)
 
-- [Install](#install)
-- [Usage](#usage)
-  - [Example workflow](#example-workflow)
-  - [vmfloaty dotfile](#vmfloaty-dotfile)
-    - [Basic configuration](#basic-configuration)
-    - [Using multiple services](#using-multiple-services)
-    - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
-    - [Valid config keys](#valid-config-keys)
-  - [Tab Completion](#tab-completion)
-- [VMPooler API](#vmpooler-api)
-- [Using the Pooler class](#using-the-pooler-class)
-  - [Example Projects](#example-projects)
-- [Contributing](#contributing)
-  - [Code Reviews](#code-reviews)
-- [Releasing](#releasing)
-- [Special thanks](#special-thanks)
+- [vmfloaty](#vmfloaty)
+  - [Install](#install)
+    - [Ruby](#ruby)
+    - [Docker](#docker)
+  - [Usage](#usage)
+    - [Example workflow](#example-workflow)
+    - [vmfloaty dotfile](#vmfloaty-dotfile)
+      - [Basic configuration](#basic-configuration)
+      - [Using multiple services](#using-multiple-services)
+      - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
+      - [Valid config keys](#valid-config-keys)
+    - [Tab Completion](#tab-completion)
+  - [VMPooler API](#vmpooler-api)
+  - [Using the Pooler class](#using-the-pooler-class)
+    - [Example Projects](#example-projects)
+  - [Contributing](#contributing)
+    - [Code Reviews](#code-reviews)
+  - [Releasing](#releasing)
+  - [Special thanks](#special-thanks)
 
 ## Install
 
+### Ruby
+
 Grab the latest from ruby gems...
 
 ```bash
 gem install vmfloaty
 ```
 
+### Docker
+
+Run the docker image:
+
+`docker run -it --rm -v ~/.vmfloaty.yml:/home/floatyuser/.vmfloaty.yml ghcr.io/puppetlabs/vmfloaty --help`
+
 ## Usage
 
 ```plain
@@ -177,10 +188,12 @@ Please wait for multiple code owners to sign off on any notable change.
 
 ## Releasing
 
-Releasing is a two step process:
+Follow these steps to publish a new GitHub release, build and push the gem to <https://rubygems.org>, and build and push a Docker Image to GitHub Container Registry:
 
-1. Submit a release prep PR that updates `lib/vmfloaty/version.rb` to the desired new version and get that merged
-2. Navigate to <https://github.com/puppetlabs/vmfloaty/actions/workflows/release.yml> --> Run workflow --> select "main" branch --> Run workflow. This will publish a GitHub release, build, and push the gem to RubyGems.
+1. Bump the "VERSION" in `lib/vmfloaty/version.rb` appropriately based on changes in `CHANGELOG.md` since the last release.
+2. Run `./release-prep` to update `Gemfile.lock` and `CHANGELOG.md`.
+3. Commit and push changes to a new branch, then open a pull request against `main` and be sure to add the "maintenance" label.
+4. After the pull request is approved and merged, then navigate to <https://github.com/puppetlabs/vmfloaty/actions/workflows/release.yml> --> Run workflow --> select "main" branch --> Run workflow. This will publish a GitHub release, build and push the gem to RubyGems, and build and push a Docker Image to GitHub Container Registry.
 
 ## Special thanks
 

data/lib/vmfloaty/utils.rb

@@ -150,7 +150,14 @@ class Utils
         tag_pairs = host_data['tags'].map { |key, value| "#{key}: #{value}" } unless host_data['tags'].nil?
         duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
         metadata = [host_data['state'], host_data['template'], duration, *tag_pairs]
-        message = "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+        # For backwards compatibility with vmpooler api v1
+        message =
+          if host_data['domain']
+            "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+          else
+            "- #{host_data['fqdn']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+          end
+
         if host_data['state'] && host_data['state'] == 'destroyed'
           output_target.puts "- DESTROYED #{hostname}.#{host_data['domain']}".gsub(/^/, ' ' * indent)
         else

data/lib/vmfloaty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Vmfloaty
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

data/spec/vmfloaty/utils_spec.rb

@@ -280,7 +280,73 @@ describe Utils do
 
     subject { Utils.pretty_print_hosts(verbose, service, hostname, print_to_stderr) }
 
-    describe 'with vmpooler service' do
+    describe 'with vmpooler api v2 service' do
+      let(:service) { Service.new(MockOptions.new, 'url' => url) }
+
+      let(:hostname) { 'mcpy42eqjxli9g2' }
+      let(:fqdn) { [hostname, 'delivery.puppetlabs.net'].join('.') }
+
+      let(:response_body) do
+        {
+          hostname => {
+            'template' => 'ubuntu-1604-x86_64',
+            'lifetime' => 12,
+            'running' => 9.66,
+            'state' => 'running',
+            'ip' => '127.0.0.1',
+            'fqdn' => fqdn
+          }
+        }
+      end
+
+      let(:default_output) { "- #{fqdn} (running, ubuntu-1604-x86_64, 9.66/12 hours)" }
+
+      it 'prints output with host fqdn, template and duration info' do
+        expect($stdout).to receive(:puts).with(default_output)
+
+        subject
+      end
+
+      context 'when tags are supplied' do
+        let(:hostname) { 'aiydvzpg23r415q' }
+        let(:response_body) do
+          {
+            hostname => {
+              'template' => 'redhat-7-x86_64',
+              'lifetime' => 48,
+              'running' => 7.67,
+              'state' => 'running',
+              'tags' => {
+                'user' => 'bob',
+                'role' => 'agent'
+              },
+              'ip' => '127.0.0.1',
+              'fqdn' => fqdn
+            }
+          }
+        end
+
+        it 'prints output with host fqdn, template, duration info, and tags' do
+          output = "- #{fqdn} (running, redhat-7-x86_64, 7.67/48 hours, user: bob, role: agent)"
+
+          expect($stdout).to receive(:puts).with(output)
+
+          subject
+        end
+      end
+
+      context 'when print_to_stderr option is true' do
+        let(:print_to_stderr) { true }
+
+        it 'outputs to stderr instead of stdout' do
+          expect($stderr).to receive(:puts).with(default_output)
+
+          subject
+        end
+      end
+    end
+
+    describe 'with vmpooler api v1 service' do
       let(:service) { Service.new(MockOptions.new, 'url' => url) }
 
       let(:hostname) { 'mcpy42eqjxli9g2' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Brian Cain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.1
 description: A helper tool for vmpooler to help you stay afloat
-email: dio-gems@puppet.com
+email: info@puppet.com
 executables:
 - floaty
 extensions: []
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler