floatyhelper 0.9 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4e929216727f3d55fec2a2ea64388bc5dd369f0a15429111cb731e56a02003
-  data.tar.gz: fd7dd9c459a81b03302142d764a8574be0148da411e6b64d4a74a8762c6037b9
+  metadata.gz: 15888ba1cfc729b4e52f5a0dd5c33e3c7873439e8c6c5422509c17ac264d0878
+  data.tar.gz: bae08f4e75b2530ba10d9a028f2346a3c89e5706015fea4258e8f1fd118e2bb6
 SHA512:
-  metadata.gz: e28f02671f5be22fb732d63465ce01f2a7f177340ff2d70c619687f4078f45707dc58248c3aab0fc85c57a85d0068d8363d6744683ee194ce4712c15d4ba2971
-  data.tar.gz: 526ac4fe3c8313e0778bfc4e91681997d47781f04f4bd55d8ffe06dff8f91901de4f88f60f97d03d100eff055c11d387c390becaf6b95708c3ce83051f49d134
+  metadata.gz: 888ebc61101ac904f1893d3698edf7adbfc41d31b34c722dbe3a21ac8c9aa538db6711f1485f2297251527787fbb4e13fb5bf1ae066cbe676ba461ac1c360743
+  data.tar.gz: 36a956a699d35d51e7af96d6a646392dfb4871605194a924a7843031742b390da071ffdc5df147c7752eb2741473c7be9a146a2d702477b36ac070bd53c3935d

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

@@ -41,7 +41,8 @@ class Floatyhelper
       c.syntax = 'floatyhelper list'
       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.option '--nocheck', 'Do not 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
@@ -49,7 +50,12 @@ class Floatyhelper
           data['vms'].each do |tag, hosts|
             puts "#{tag}:"
             hosts.each do |host|
-              puts "  #{host}"
+              remaining = ''
+              unless options.nocheck
+                query = VM.query(host)
+                remaining = VM.alive(host, query) ? "#{query[host]['remaining']} hours remaining" : "Expired"
+              end
+              puts "  #{host}\t#{remaining}"
             end
           end
         end
@@ -95,10 +101,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 +115,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 +148,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 +185,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
@@ -239,6 +264,55 @@ class Floatyhelper
         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|
+          is_alive = false
+          hosts.each do |host|
+            is_alive |= VM.alive(host)
+          end
+          unless is_alive
+            expired = true
+            if options.y
+              answer = 'y'
+            else
+              answer = ask "All hosts in tag #{tag} have expired. Delete this tag? [Y/n] ".yellow
+            end
+            if answer.empty? || answer.capitalize == 'Y'
+              Groups.delete_tag(tag) 
+              puts "Tag #{tag} deleted".green
+            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.9"
+  VERSION = "1.0"
 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)
@@ -92,5 +98,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.9'
+  version: '1.0'
 platform: ruby
 authors:
 - Nick Burgan-Illig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler