floatyhelper 1.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9107871b6337de1b4508247eebc2f59e1250e5ed7b61a4ee358f3e7d920e5e5
-  data.tar.gz: d346fccc76b850c599d9ab7bef16e2a5eebb51897482158e273d45c7082bb9fa
+  metadata.gz: ab5a427189944d8960bab3ac42f1def0053e19fbed5a76d23fe866bef85ea28d
+  data.tar.gz: acddc4079e86b93b58a3ac1f4df3163fa440595e5f499f130ad5babeaa42f0cd
 SHA512:
-  metadata.gz: 23e2932ddc4a3f11edbd8cff698420d83f3e41c9e0e13b92b8391e6eb474cfe5078958542e4b572a9f99728ed2a7fe6832fba17d9f3958d744da153cfb537832
-  data.tar.gz: 1600273e214fb4abf841f64150ccaf393e14088e312e3147af8adb9c2634e4ce4c3642c0974470e03bf96a37147657d7750a5e7ae44940a38fe8bb0b0445747e
+  metadata.gz: 97a90ee999e59877c3125cd96611b3de3a5eead211800eb0f233e9e2a9951680583309b053b173a3cb402c2b8ed4f8e7f698fb44e5484c86520e1875f5820604
+  data.tar.gz: cbb27ccfe2310492034eb123a0bff8c7e39dc681091fc6bec444084a390c581c8e18d8d1b9ffd6a2729e1b591c0c1d52c93d7bb34bdf37e6c460f7d0e428bf6f

data/README.md

@@ -1,28 +1,14 @@
 # Floatyhelper
 
-A CLI app for manipulating groups of VMs provisioned with vmpooler.  Works on top of https://github.com/briancain/vmfloaty
+A CLI app for manipulating groups of VMs provisioned with vmpooler.  Works on top of https://github.com/puppetlabs/vmfloaty
 
-This was written to aid the installer and management team with testing various configurations of Puppet Enterprise.  Groups of hosts can be added (either directly from a Beaker run from inside the pe_acceptance_tests folder it was run with, or manually with the --hosts flag) and given a "tag" to refer to the group of hosts by.  These hosts can be snapshotted together, with these snapshots given a "snaptag" that can then be reverted to if needed. 
+This was written to aid Puppet development teams with testing various configurations of Puppet Enterprise or other Puppet products.  Groups of hosts can be added (either directly from a Beaker run from inside the pe_acceptance_tests folder it was run with, or manually with the --hosts flag) and given a "tag" to refer to the group of hosts by.  These hosts can be snapshotted together, with these snapshots given a "snaptag" that can then be reverted to if needed. 
 
-NOTE: This requires that you have already set up your .vmfloaty file with the appropriate token. The app currently does not check that this is the case.
-
-This tool could use some specs and linting, probably.
+The app will install vmfloaty for you and ensure your .vmfloaty.yml config file is correct. If no tokens are present in the file, it will request new tokens for you.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'floatyhelper'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install floatyhelper
+This app lives on RubyGems, so to install, simply run `gem install floatyhelper`
 
 ## Usage
 
@@ -31,21 +17,27 @@ floatyhelper <command> <options>
 ```
 The following commands are currently available:
 
-`floatyhelper tags` - List all currently tracked tags that specify groups of hosts
+`floatyhelper config` - Lists, gets, or sets floatyhelper configuration settings.
+
+`floatyhelper tags` - List all currently tracked tags that specify groups of hosts.
 
-`floatyhelper list` - List all VMs and their associated tags, and checks the remaining lifetime for each VM. If --nocheck is passed, lifetime checking will not occur.
+`floatyhelper list` - List all VMs and their associated tags, and optionally checks the type and remaining lifetime for each VM.
 
-`floatyhelper snaplist <tag>` - List all of the snaptags associated with the given VM group tag
+`floatyhelper check` - Same as `floatyhelper list --check`.
+
+`floatyhelper snaplist <tag>` - List all of the snaptags associated with the given VM group tag.
 
 `floatyhelper showconfig` - Dumps the .floatyhelper.yaml file. Primarily used for debug purposes.
 
-`floatyhelper addhosts <tag> [--hosts HOST1,HOST2,...] [--file sutfile]` - Takes all hosts defined in a beaker sut.log file and adds them to the list of hosts floatyhelper is tracking. These hosts will be grouped under the given tag, so that this tag can be used to operate on the whole set of hosts at once. If `--file` is not specified, this assumes you are inside a pe_acceptance_tests folder and grabs the lsit of hosts from `log/latest/sut.log`. If --hosts is specified, it will add the given comma-separated list of hosts.
+`floatyhelper addhosts <tag> [--hosts HOST1,HOST2,...] [--file sutfile]` - Takes all hosts defined in a beaker sut.log file and adds them to the list of hosts floatyhelper is tracking. These hosts will be grouped under the given tag, so that this tag can be used to operate on the whole set of hosts at once. If `--file` is not specified, this assumes you are inside a pe_acceptance_tests folder and grabs the list of hosts from `log/latest/sut.log`. If --hosts is specified, it will add the given comma-separated list of hosts.
+
+`floatyhelper movehost <host> <tag>` - Moves a host between two different tags.
 
-`floatyhelper appendhosts <tag> [--hosts HOST1,HOST2,...] [--file sutfile]` - Similar to the addhosts command, but adds the given hosts to the list of hosts tracked under a given tag.
+`floatyhelper destroy <tag> [--all] [--hosts HOSTS]` - Calls `floaty delete` on the vmpooler hosts with the given tag, or the given hosts, or all hosts managed by floatyhelper.
 
-`floatyhelper destroy <tag> [--all] [--hosts HOSTS]` - Calls `floaty delete` on the vmpooler hosts with the given tag.
+`floatyhelper destroy_from_token` - This destroys all hosts tied to your vmpooler token. Note that this does not currently remove the hosts from floatyhelper management. This is mostly a helper for when you have been using `floaty` directly to request VMs and you have some that are not managed by floatyhelper.
 
-`floatyhelper increaselife <tag> [options]` - Increases the lifetime of the given host or tagged hosts.  Defaults to 100 hours.
+`floatyhelper increaselife <tag> [options]` - Increases the lifetime of the given host or tagged hosts.  Defaults to the increaselife config setting value.
 
 `floatyhelper snapshot <host|tag> <snaptag>` - Snapshots the given VM or group of tagged hosts, and defines a string to use as a snaptag to refer to this group of snapshots.
 
@@ -53,13 +45,13 @@ The following commands are currently available:
 
 `floatyhelper refresh` - Removes tags that contain only expired VMs. You may pass the -y argument to run non-interactively.
 
-`floatyhelper getvm [platform] [tag]` - Request a VM from floaty, and add the host to the given tag. Defaults to centos-7-x86_64 if no platform is given, and defaults to "Unassigned" tag.
+`floatyhelper getvm [platform] [tag]` - Request a VM from floaty, and add the host to the given tag. Defaults to centos-7-x86_64 if no platform is given, and defaults to "Unassigned" tag. If requesting a platform that is currently pooled, it will request it from vmpooler. Otherwise, it will request it from ABS (or if the --abs flag is used).
 
-`floatyhelper movehost <host> <tag>` - Moves the given host from its existing tag to the given tag
+`floatyhelper checktokens` - Checks the tokens in .vmfloaty.yml and requests new ones if needed.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/nmburgan/floatyhelper.
+Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/floatyhelper.
 
 To build locally,
 ```
@@ -68,19 +60,10 @@ bundle exec rake build
 ```
 This will create the gem in the `pkg` directory.  You can then install it locally with `gem install`.
 
-## License
+Run specs with `bundle exec rake spec` and Rubocop with `bundle exec rake rubocop`. These will be run automatically by Travis on all PRs.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+To release a new version, update lib/version.rb, then run `bundle exec build release`.
 
-## Changelog
-
-### 0.9 
-  * First release
+## License
 
-### 1.0 
-  * Added refresh command
-  * Added getvm command
-  * Added movehost command
-  * Added functionality to check for remaining VM lifetime with the list command
-  * Added --nocheck option for list command to prevent checking VM lifetime
-  * Tag automatically added if appendhosts is used with a tag that doesn't exist
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/floatyhelper/config.rb

@@ -0,0 +1,75 @@
+# This is for directly manipulating the yaml file, as well as
+# storing configuration for floatyhelper itself.
+require 'yaml'
+require 'etc'
+
+class Config
+  DEFAULT_CONF_FILE = <<~EOT
+    ---
+    config: {}
+    vms: {}
+    snapshots: {}
+  EOT
+                      .freeze
+
+  VALID_SETTINGS = {
+    'increaselife' => {
+      'description' => 'Number of hours beyond the service default to increase the VM lifetime when adding a VM to floatyhelper.',
+      'default' => 0,
+    },
+    'vertical_snapshot_status' => {
+      'description' => 'When true, clear the screen and show the snapshot in progress status vertically. Otherwise, show status on a single line.',
+      'default' => true,
+    },
+  }.freeze
+
+  attr_reader :VALID_SETTINGS
+
+  def self.fhfile
+    "#{Etc.getpwuid.dir}/.floatyhelper.yaml"
+  end
+
+  def self.load_data
+    File.write(fhfile, DEFAULT_CONF_FILE) unless File.exist?(fhfile)
+    data = YAML.load_file(fhfile)
+    # If someone is using an older version, ensure the conf file has
+    # all the correct top-level keys. Only write it back if we modify
+    # the data to add a top-level key.
+    writeback = false
+    ['config', 'vms', 'snapshots'].each do |key|
+      if !data.keys.include?(key)
+        data[key] = {}
+        writeback = true
+      end
+    end
+
+    # Config setting defaults
+    VALID_SETTINGS.each do |setting, info|
+      writeback = true if data['config'][setting].nil?
+      data['config'][setting] ||= info['default']
+    end
+
+    write_data(data) if writeback
+    data
+  end
+
+  # It is up to the calling function to ensure the data object
+  # being passed in is a properly formatted hash. It should only be
+  # used to modify after reading the current state with load_data.
+  def self.write_data(data)
+    File.write(fhfile, data.to_yaml)
+  end
+
+  # NOTE: Anything currently set with 'floatyhelper config set' will return a string,
+  # regardless of its intended type. Need to add typing one of these days.
+  def self.get_config_setting(setting)
+    data = load_data
+    data['config'][setting]
+  end
+
+  def self.set_config_setting(setting, value)
+    data = load_data
+    data['config'][setting] = value
+    write_data(data)
+  end
+end

data/lib/floatyhelper/floaty.rb

@@ -0,0 +1,154 @@
+# This is for talking to floaty and getting data back from it.
+require 'json'
+require 'open3'
+require 'colorize'
+require 'pty'
+
+class Floaty
+  FLOATY_SERVICES = {
+    'abs' => {
+      'type' => 'abs',
+      'url' => 'https://abs-prod.k8s.infracore.puppet.net/api/v2',
+    },
+    'vmpooler' => {
+      'type' => 'vm',
+      'url' => 'http://vmpooler.delivery.puppetlabs.net',
+    },
+    'nspooler' => {
+      'type' => 'nonstandard',
+      'url' => 'https://nspooler-prod.k8s.infracore.puppet.net',
+    },
+  }.freeze
+
+  def self.vmfloatyfile
+    "#{Etc.getpwuid.dir}/.vmfloaty.yml"
+  end
+
+  def self.load_vmfloaty_config
+    if File.exist?(vmfloatyfile)
+      YAML.safe_load(File.read(vmfloatyfile))
+    else
+      {}
+    end
+  end
+
+  # This adds some stdout printing here which I was trying to avoid, but
+  # I think it makes sense to put it here rather than the main floatyhelper
+  # somewhere.
+  def self.check_floaty(data = nil)
+    data ||= load_vmfloaty_config
+
+    user = data['user']
+    unless user
+      puts 'No username found in .vmfloaty.yml.'.yellow
+      user = ask('Username: ').chomp
+      data['user'] = user
+    end
+    data['services'] ||= {}
+    puts 'No services defined in .vmfloaty.yml.' if data['services'].empty?
+
+    need_token = FLOATY_SERVICES.keys.any? { |k| !data['services'].keys.include?(k) } || data['services'].any? { |_svc, val| val['token'].nil? }
+    return unless need_token
+
+    puts 'It appears we need to fetch one or more tokens for the ~/.vmfloaty.yml file. Please enter your Puppet password.'
+    password = ask('Password: ') { |q| q.echo = '*' }
+    FLOATY_SERVICES.each do |service, info|
+      next if data['services'][service] && data['services'][service]['token']
+
+      data['services'][service] ||= {}
+      # Kind of silly to call out to curl here.  Replace this with a Net::HTTP call
+      output, status = Open3.capture2e("curl -s -X POST -u #{user}:#{password} --url #{info['url']}/token")
+      unless status.exitstatus.zero?
+        puts "Bad return status from curl to #{info['url']}: #{status.exitstatus}".red
+        exit status.exitstatus
+      end
+      result = JSON.parse(output)
+      if result['ok']
+        data['services'][service]['type'] = info['type']
+        data['services'][service]['url'] = info['url']
+        data['services'][service]['token'] = result['token']
+        puts "Successfully fetched token for #{service}".green
+      else
+        puts "Could not get a token from #{service}. Please ensure your username and password are correct.".red
+        puts "Result: #{result}".red
+        exit 1
+      end
+    end
+    File.write(vmfloatyfile, data.to_yaml)
+  end
+
+  # Make sure all tokens are valid
+  def self.check_tokens
+    data = load_vmfloaty_config
+    issues = false
+    FLOATY_SERVICES.each do |service, _info|
+      if data['services'].nil? || data['services'][service].nil? || data['services'][service]['token'].nil?
+        puts "#{service} service token not found in .vmfloaty.yml".yellow
+        issues = true
+        next
+      end
+      # TODO: See what exitcode is when token is bad vs. some other fatal error
+      output, _status = Open3.capture2e("/usr/bin/env floaty token status --service #{service}")
+      result = parse_floaty_json_output(output)
+      next if result['ok']
+
+      puts "Problem checking #{service} token: #{result['reason']}".red
+      data['services']['token'] = nil
+      issues = true
+    end
+    if issues
+      check_floaty(data)
+    else
+      puts 'All tokens valid'.green
+    end
+  end
+
+  def self.parse_floaty_json_output(output)
+    # Sometimes there will be extra stuff before the hash output,
+    # so ignore it until we reach the hash.
+    lines = output.split("\n")
+    index = lines.index { |l| l[0] == '{' }
+    output = lines[index..-1].join
+    JSON.parse(output.gsub('=>',':'))
+  end
+
+  def self.floaty_cmd(command, ignore_error: false, use_pty: false)
+    check_floaty
+    # While we could potentially make a Vmfloaty object and send a command
+    # that way, Commander doesn't make it easy.  Parsing floaty's stdout
+    # isn't great, but it works for now.
+    if use_pty
+      output = ''
+      status = nil
+      PTY.spawn("/usr/bin/env floaty #{command}") do |read, write, pid|
+        write.close
+        while status.nil?
+          begin
+            line = read.gets
+            puts line
+            output += line
+          rescue EOFError, Errno::EIO
+            # GNU/Linux raises EIO on read operation when pty is closed - see pty.rb docs
+            # Ensure child process finishes and then pass through to ensure below to get status
+            nil
+          rescue IO::WaitReadable, IO::WaitWritable
+            retry
+          ensure
+            status ||= PTY.check(pid)
+          end
+        end
+
+        Process.waitall
+        # Double check we have the status
+        status ||= PTY.check(pid)
+      end
+    else
+      output, status = Open3.capture2e("/usr/bin/env floaty #{command}")
+    end
+    if !status.exitstatus.zero? && !ignore_error
+      puts "Error running 'floaty #{command}': #{output}".red
+      exit status.exitstatus
+    end
+    output
+  end
+end

data/lib/floatyhelper/groups.rb

@@ -1,65 +1,76 @@
-require 'floatyhelper/conf'
+# This is for the management of hosts and snapshots in the yaml config file.
+# Anything for adding, removing, or modifying hosts or snapshots in the
+# floatyhelper.yaml file belongs here. Anything for modifying the VMs themselves
+# does not.
+require 'floatyhelper/config'
 
 class Groups
-  def self.is_tag?(id)
-    data = Conf.load_data
+  def self.get_tags
+    data = Config.load_data
+    data['vms'].keys
+  end
+
+  def self.tag?(id)
+    data = Config.load_data
     data['vms'].keys.include?(id)
   end
 
-  def self.delete_tag(tag)
-    data = Conf.load_data
+  def self.delete_tag(tag, data: nil)
+    data ||= Config.load_data
     data['vms'].delete(tag)
     data['snapshots'].delete(tag) if data['snapshots'].keys.include?(tag)
-    Conf.write_data(data)
+    Config.write_data(data)
   end
 
   def self.delete_all
-    data = Conf.load_data
+    data = Config.load_data
     data['vms'] = {}
     data['snapshots'] = {}
-    Conf.write_data(data)
+    Config.write_data(data)
   end
 
-  def self.addhosts(hosts, tag)
-    data = Conf.load_data
-    data['vms'] ||= {}
-    tag = 'Blank Tag' unless tag #Removed the ability to do this
-    hosts.each do |host|
-      data['vms'][tag] ||= []
-      data['vms'][tag] << host unless data['vms'][tag].include?(host)
-    end
-    Conf.write_data(data)
+  def self.get_hosts(tag)
+    data = Config.load_data
+    data['vms'][tag]
   end
 
-  def self.appendhosts(hosts, tag)
-    data = Conf.load_data
+  def self.addhosts(hosts, tag)
+    data = Config.load_data
+    data['vms'] ||= {}
+    tag ||= 'Blank Tag' # Removed the ability to do this
     hosts.each do |host|
       data['vms'][tag] ||= []
       data['vms'][tag] << host unless data['vms'][tag].include?(host)
     end
-    Conf.write_data(data)
+    Config.write_data(data)
   end
 
   def self.removehosts(hosts, tag)
-    data = Conf.load_data
+    data = Config.load_data
+    return if data['vms'][tag].nil?
+
     hosts.each do |host|
       data['vms'][tag] ||= []
       data['vms'][tag].delete(host)
-      data['vms'].delete(tag) if data['vms'][tag].empty?
+      if data['snapshots'][tag]
+        data['snapshots'][tag].each do |snaptag, _vals|
+          data['snapshots'][tag][snaptag].delete(host)
+        end
+      end
+      delete_tag(tag, data: data) if data['vms'][tag].empty?
     end
-    Conf.write_data(data)
+    Config.write_data(data)
   end
 
-  def self.is_managed_host?(host)
-    data = Conf.load_data
-    data['vms'].any? { |tag, hosts| hosts.include?(host) }
+  def self.managed_host?(host)
+    data = Config.load_data
+    data['vms'].any? { |_tag, hosts| hosts.include?(host) }
   end
 
   def self.host_tag(host)
-    data = Conf.load_data
-    raise 'Host not found' unless is_managed_host?(host)
-    tags = data['vms'].select { |tag, hosts| hosts.include?(host) }.keys
+    data = Config.load_data
+    raise 'Host not found' unless managed_host?(host)
+    tags = data['vms'].select { |_tag, hosts| hosts.include?(host) }.keys
     tags[0]
   end
-  
-end
+end

data/lib/floatyhelper/hosts.rb

@@ -1,14 +1,15 @@
-require 'floatyhelper/conf'
+# This is for finding hosts in various places (sut.log, --hosts flag)
+# and returning an array of hostnames.
+require 'floatyhelper/config'
 require 'floatyhelper/groups'
 
 class Hosts
-
   def self.get_hosts_from_sut_log(file)
     hosts = []
     File.open(file).each do |line|
       items = line.split("\t")
-      hostname, tag = items[4].split(" ")
-      short_host = hostname.split(".")[0]
+      hostname, tag = items[4].split # rubocop:disable Lint/UselessAssignment
+      short_host = hostname.split('.')[0]
       hosts << short_host
     end
     hosts
@@ -20,20 +21,19 @@ class Hosts
   end
 
   def self.get_hosts_from_id(id)
-    data = Conf.load_data
+    data = Config.load_data
     if id == 'all'
       hosts = []
-      data['vms'].each do |tag, hostlist|
+      data['vms'].each do |_tag, hostlist|
         hostlist.each do |host|
           hosts << host unless hosts.include?(host)
         end
       end
-    elsif Groups.is_tag?(id)
+    elsif Groups.tag?(id)
       hosts = data['vms'][id]
     else
       hosts = [id].flatten
     end
     hosts
   end
-
-end
+end

data/lib/floatyhelper/version.rb

@@ -1,3 +1,3 @@
-module Floatyhelper
-  VERSION = "1.4"
+module FloatyhelperVersion
+  VERSION = '2.0.1'.freeze
 end