floatyhelper 0.8 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d43c23e8cc5d7507aeea8022735d7d8446c820751403613a6edff026b929c4
-  data.tar.gz: 96025e91a3e472d9c047ebf24310cccb1cf6db5b786ceb73987297021b55169c
+  metadata.gz: b9107871b6337de1b4508247eebc2f59e1250e5ed7b61a4ee358f3e7d920e5e5
+  data.tar.gz: d346fccc76b850c599d9ab7bef16e2a5eebb51897482158e273d45c7082bb9fa
 SHA512:
-  metadata.gz: 2817a116a25ffe2d230476244c6258e565384b69db9d68c9adc35259809bdd3064aae068aa4adacc74d7bcfe157f0d32c8958bc05863251a215d76fb2d665294
-  data.tar.gz: b3022014f3e911c8d6e0cdeee863ac8832b3a187fc8c3c85b9f9fc16ec07232dadfd4c98e9beaea08f9c6c895304387ba5f62988322d2601949e4e1b5784edcf
+  metadata.gz: 23e2932ddc4a3f11edbd8cff698420d83f3e41c9e0e13b92b8391e6eb474cfe5078958542e4b572a9f99728ed2a7fe6832fba17d9f3958d744da153cfb537832
+  data.tar.gz: 1600273e214fb4abf841f64150ccaf393e14088e312e3147af8adb9c2634e4ce4c3642c0974470e03bf96a37147657d7750a5e7ae44940a38fe8bb0b0445747e

data/README.md

@@ -18,7 +18,7 @@ gem 'floatyhelper'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -33,7 +33,7 @@ The following commands are currently available:
 
 `floatyhelper tags` - List all currently tracked tags that specify groups of hosts
 
-`floatyhelper list` - List all VMs and their associated tags
+`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 snaplist <tag>` - List all of the snaptags associated with the given VM group tag
 
@@ -51,10 +51,36 @@ The following commands are currently available:
 
 `floatyhelper revert <host|tag> <snaptag>` - Reverts the given VM or host group to the given snaptag.
 
+`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 movehost <host> <tag>` - Moves the given host from its existing tag to the given tag
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nmburgan/floatyhelper.
 
+To build locally,
+```
+bundle install
+bundle exec rake build
+```
+This will create the gem in the `pkg` directory.  You can then install it locally with `gem install`.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+### 0.9 
+  * First release
+
+### 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

data/lib/floatyhelper.rb

@@ -15,7 +15,7 @@ class Floatyhelper
   def run
     program :name, 'floatyhelper'
     program :version, '1.0.0'
-    program :description, <<-EOT
+    program :description, <<~EOT
     Commands for manipulating vmpooler VMs with floaty. Use the addhosts command from within a pe_acceptance_tests folder
     that has recently finished a run to add those hosts to the list of hosts managed by floatyhelper (or specify a sut.log
     file directly).
@@ -38,24 +38,49 @@ class Floatyhelper
     end
 
     command :list do |c|
-      c.syntax = 'floatyhelper list'
+      c.syntax = 'floatyhelper list [tag]'
       c.summary = 'List all VMs and their associated tags'
-      c.description = 'This lists all VMs currently defined in the status.yaml file, added via the addhosts command, and their associated tags.'
-      c.action do |args|
+      c.description = <<~EOT
+      This lists all VMs currently defined in the status.yaml file, added via the addhosts command, and their associated tags.
+      If a tag is specified, it will only lists the hosts in that tag.
+      EOT
+      c.option '--check', 'Check remaining lifetime of each VM'
+      c.action do |args, options|
         data = Conf.load_data
         if data['vms'].keys.length == 0
           puts 'No VM groups are defined'.yellow
         else
+          requested_tag = args.count > 0 ? args[0] : nil
           data['vms'].each do |tag, hosts|
+            next if requested_tag && requested_tag != tag
             puts "#{tag}:"
             hosts.each do |host|
-              puts "  #{host}"
+              remaining = ''
+              type = ''
+              if options.check
+                query = VM.query(host)
+                type = query[host]['template'].gsub('-pixa4','')
+                remaining = VM.alive(host, query) ? "#{query[host]['remaining']} hours remaining" : "Expired"
+              end
+              puts "  %-15s  %-28s  %s" % [host, type, remaining]
             end
           end
         end
       end
     end
 
+    command :check do |c|
+      c.syntax = 'floatyhelper check [tag]'
+      c.summary = 'Checks the remaining lifetime of each tracked VM.'
+      c.description = <<~EOT
+      Same as floatyhelper list --check. Checks the remaining lifetime of each tracked VM.
+      If a tag is specified, it will only check hosts in that tag.
+      EOT
+      c.action do |args, options|
+        command(:list).run(*args,'--check')
+      end
+    end
+
     command :snaplist do |c|
       c.syntax = 'floatyhelper snaplist <tag>'
       c.summary = 'List all snaptags saved for the given tag'
@@ -95,10 +120,11 @@ class Floatyhelper
       c.option '--hosts HOSTS', String, 'Comma separated list of hosts to add instead of reading sut.log'
       c.option '--file SUTFILE', String, 'Path to a sut.log file to get hosts from'
       c.action do |args, options|
+        disallowed_tags = ['all','All','Unassigned']
         if args.size == 0
           puts 'Please add a tag to use.'.red
-        elsif args[0] == 'all'
-          puts 'Can not use a tag named "all"'.red
+        elsif disallowed_tags.include?(args[0])
+          puts "Can not use a tag named #{args[0]}".red
         else
           tag = args[0]
           if options.hosts
@@ -108,9 +134,9 @@ class Floatyhelper
             hosts = Hosts.get_hosts_from_sut_log(sutlog)
           end
           Groups.addhosts(hosts, tag)
+          VM.increaselife(tag, nil)
           puts "Added the following hosts with tag #{tag}:".green
           hosts.each { |host| puts host }
-          VM.increaselife(tag, nil)
         end
       end
     end
@@ -141,9 +167,26 @@ class Floatyhelper
             hosts = Hosts.get_hosts_from_sut_log(sutlog)
           end
           Groups.appendhosts(hosts, tag)
+          VM.increaselife(hosts, nil)
           puts "Added the following hosts to tag #{tag}".green
           hosts.each { |host| puts host }
-          VM.increaselife(hosts, nil)
+        end
+      end
+    end
+
+    command :movehost do |c|
+      c.syntax = 'floatyhelper movehost <host> <tag>'
+      c.summary = 'Moves given host into the given tag group'
+      c.description = 'Moves the given host from its existing tag group to the given tag group. Will throw an error if either the host is not currently being managed by floatyhelper. Note that snapshots will NOT be migrated to the new group.'
+      c.action do |args|
+        if args.size < 2
+          puts 'Please specify both a host and a tag.'.red
+        elsif !Groups.is_managed_host?(args[0])
+          puts "Could not find host #{args[0]}".red
+        else
+          Groups.removehosts([args[0]], Groups.host_tag(args[0]))
+          Groups.appendhosts([args[0]], args[1])
+          puts "Moved #{args[0]} to #{args[1]}".green
         end
       end
     end
@@ -161,6 +204,7 @@ class Floatyhelper
         else
           id = options.all ? 'all' : options.hosts ? Hosts.get_options_hosts(options.hosts) : args[0]
           VM.destroy(id)
+          puts "Destroyed hosts in #{id}".green
         end
       end
     end
@@ -227,19 +271,73 @@ class Floatyhelper
       c.syntax = 'floatyhelper snapshot <host|tag> <snaptag>'
       c.summary = 'Snapshot the given VM or group of taggedhosts'
       c.description = 'Creates a snapshot of a host or group of tagged hosts, and defines a string to use as a "snaptag" to refer to this group of snapshots.'
+      c.option '--clr', 'Clear screen and show VMs in a column when checking status, rather than a single line.'
       c.action do |args, options|
         if args.length < 2
           puts "Please specify both a host/tag and a snaptag"
         else
           if VM.snaptag_exists?(args[0], args[1])
-            print "Snaptag #{args[1]} already exists. Are you sure you want to overwrite? [y/N] ".yellow
-            gets response
-            return unless response.capitalize == 'Y'
+            answer = ask "Snaptag #{args[1]} already exists. Are you sure you want to overwrite? [y/N] ".yellow
+            return unless answer.capitalize == 'Y'
+          end
+          VM.snapshot(args[0], args[1], options.clr)
+        end
+      end
+    end
+
+    command :refresh do |c|
+      c.syntax = 'floatyhelper refresh'
+      c.summary = 'Check for any expired VMs, and remove them from the list of hosts floatyhelper is tracking'
+      c.description = 'Runs floaty query on VMs that floatyhelper is tracking, to check for any expired VMs, and allows the user to remove tags that contain only expired VMs.'
+      c.option '-y', 'Do not prompt to remove tags with expired VMs'
+      c.action do |args, options|
+        data = Conf.load_data
+        expired = false
+        data['vms'].each do |tag, hosts|
+          expired_hosts = []
+          hosts.each do |host|
+            expired_hosts << host unless VM.alive(host)
           end
-          VM.snapshot(args[0], args[1])
+          unless expired_hosts.empty?
+            expired = true
+            if expired_hosts & hosts == hosts
+              answer = options.y ? 'y' : ask("All hosts in tag #{tag} have expired. Delete this tag? [Y/n] ".yellow)
+              if answer.empty? || answer.capitalize == 'Y'
+                Groups.delete_tag(tag) 
+                puts "Tag #{tag} deleted".green
+              end
+            else
+              expired_hosts.each { |host| puts "#{host}".yellow } unless options.y
+              answer = options.y ? 'y' : ask("The above hosts in tag #{tag} have expired. Delete these hosts from the tag? [Y/n]".yellow)
+              if answer.empty? || answer.capitalize == 'Y'
+                Groups.removehosts(expired_hosts, tag)
+                puts "Expired hosts from #{tag} deleted".green
+              end
+            end
+          end
+        end
+        puts "No managed VMs have expired".green unless expired
+      end
+    end
+
+    command :getvm do |c|
+      c.syntax = 'floatyhelper getvm <platform> <tag>'
+      c.summary = 'Request a VM from floaty'
+      c.description = 'Request a VM of the given platform type from floaty, and add the host to either the given tag or the Unassigned tag, if none is given. If no platform is given, default to centos-7-x86_64.'
+      c.action do |args|
+        platform = args.length > 0 ? args[0] : 'centos-7-x86_64'
+        tag = args.length > 1 ? args[1] : 'Unassigned'
+        begin
+          host = VM.get_vm(platform)
+          Groups.appendhosts([host], tag)
+          puts "Added #{host} to tag #{tag}".green
+          VM.increaselife(host, nil)
+        rescue => exception
+          puts exception.message.red
         end
       end
     end
+
     run!
   end
 end

data/lib/floatyhelper/groups.rb

@@ -34,9 +34,32 @@ class Groups
   def self.appendhosts(hosts, tag)
     data = Conf.load_data
     hosts.each do |host|
+      data['vms'][tag] ||= []
       data['vms'][tag] << host unless data['vms'][tag].include?(host)
     end
     Conf.write_data(data)
   end
+
+  def self.removehosts(hosts, tag)
+    data = Conf.load_data
+    hosts.each do |host|
+      data['vms'][tag] ||= []
+      data['vms'][tag].delete(host)
+      data['vms'].delete(tag) if data['vms'][tag].empty?
+    end
+    Conf.write_data(data)
+  end
+
+  def self.is_managed_host?(host)
+    data = Conf.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
+    tags[0]
+  end
   
 end

data/lib/floatyhelper/version.rb

@@ -1,3 +1,3 @@
 module Floatyhelper
-  VERSION = "0.8"
+  VERSION = "1.4"
 end

data/lib/floatyhelper/vm.rb

@@ -8,7 +8,8 @@ class VM
     hosts = Hosts.get_hosts_from_id(id)
     Groups.delete_tag(id) if Groups.is_tag?(id)
     Groups.delete_all if id == 'all'
-    puts `floaty delete #{hosts.join(',')}`
+    hosts = hosts.select { |host| alive(host) }
+    puts `floaty delete #{hosts.join(',')}` unless hosts.empty?
   end
 
   def self.query(host)
@@ -20,6 +21,11 @@ class VM
     status['ok'] ? status[host]['lifetime'] : nil
   end
 
+  def self.alive(host, query=nil)
+    query ||= query(host)
+    query['ok'] && query[host]['state'] == 'running'
+  end
+
   def self.increaselife(id, amount)
     amount = 100 if amount.nil?
     hosts = Hosts.get_hosts_from_id(id)
@@ -34,7 +40,7 @@ class VM
     end
   end
 
-  def self.snapshot(id, snaptag)
+  def self.snapshot(id, snaptag, clr=false)
     snaptag = 'Blank Snaptag' unless snaptag
     hosts = Hosts.get_hosts_from_id(id)
     shas = {}
@@ -48,27 +54,30 @@ class VM
       shas[host] = sha
     end
 
+    data = Conf.load_data
+    data['snapshots'] ||= {}
+    data['snapshots'][id] ||= {}
+    data['snapshots'][id][snaptag] = shas
+    Conf.write_data(data)
+
+    puts `tput clear` if clr
     puts 'Waiting for snapshots to appear in floaty query...'
     alldone = false
     while !alldone do
+      puts `tput cup 1` if clr
       alldone = true
-      print "\r"
+      print "\r" unless clr
       hosts.each do |host|
         answer = eval(`floaty query #{host}`)[host]
         done = answer.keys.include?('snapshots') && answer['snapshots'].include?(shas[host])
         status = done ? 'Done' : 'Wait'
-        print "* #{host}: #{status} *"
+        print "* #{host}: #{status} *" unless clr
+        puts "* #{host}: #{status} *" if clr
         alldone &= done
       end
       sleep(1)
     end
     puts ''
-
-    data = Conf.load_data
-    data['snapshots'] ||= {}
-    data['snapshots'][id] ||= {}
-    data['snapshots'][id][snaptag] = shas
-    Conf.write_data(data)
   end
 
   def self.getsnapshot(id, snaptag)
@@ -92,5 +101,11 @@ class VM
     sleep(10)
   end
 
+  def self.get_vm(platform='centos-7-x86_64')
+    response = `floaty get #{platform} 2>&1`
+    raise "Error obtaining a VM: #{response}" if response.include?('error')
+    return response.split(' ')[1].split('.')[0]
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floatyhelper
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '1.4'
 platform: ruby
 authors:
 - Nick Burgan-Illig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler