beaker-abs 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82eb019d362ee494be591f4c05a9cd436b36d58f
-  data.tar.gz: f6a5815d36c276af5dca0716bb247c0a970ed2e6
+SHA256:
+  metadata.gz: 27a203607bea7dbf86a777845e5001652eaaf84cb9e4cf68bdd363101bbd4720
+  data.tar.gz: 254e86cb24ad8dd8485b04d1eb051cd174e50f04cbe71a8a6a587477d6b2f5c6
 SHA512:
-  metadata.gz: 2446833607e222a257fbdea166829e3d96d2cc35e27d1d65bd499af0726c96ea5a5f11257aced79f8ae38fd83fcdac49bc17fcf37ac9e0bc7401c7aadb5034a8
-  data.tar.gz: fecd4f6291c4b2455914803d51eef9eaf1f587589535914a4b4df1cf86b8be6ef827e098ff8e1035800cb3e618688a3de7f0eff3219a69c880d61785ec022086
+  metadata.gz: 076db68386151e5accabb9c2b1407b2c1ddaf43904083c58b99007b3627283a1362943190d4471d4fa2cf51412b7c1f5de8e1c97416f1ece296a0baa564b4cd1
+  data.tar.gz: 168fee1b01fe2266bc2cf48dffa16753ab5ae2c9645077218ca2fc85e81742abb37bd9569bc165f1452d4ab2a29191d3b7900dc7ebcd014158b35173ffacc315

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.travis.yml

@@ -1,5 +1,6 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.1.8
-before_install: gem install bundler -v 1.12.3
+  - 2.6
+before_install:
+  - gem install bundler
+

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppetlabs/beaker

data/Gemfile

@@ -2,3 +2,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in beaker-abs.gemspec
 gemspec
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git:[^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+group :testing do
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 4.0')
+end

data/README.md

@@ -1,22 +1,21 @@
-# BeakerAbs
+# beaker-abs
 
 Implements a Beaker hypervisor that makes hosts provisioned by the AlwaysBeScheduling service available to a Beaker run.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Beaker will automatically load the appropriate hypervisors for any given hosts file, so as long as your project dependencies are satisfied there's nothing else to do. No need to `require` this library in your tests.
 
-```ruby
-gem 'beaker-abs'
-```
-
-And then execute:
-
-    $ bundle
+As of Beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g.
 
-Or install it yourself as:
-
-    $ gem install beaker-abs
+~~~ruby
+# Gemfile
+gem 'beaker', '~>4.0'
+gem 'beaker-abs'
+# project.gemspec
+s.add_runtime_dependency 'beaker', '~>4.0'
+s.add_runtime_dependency 'beaker-abs'
+~~~
 
 ## Usage
 
@@ -42,6 +41,32 @@ env ABS_RESOURCE_HOSTS=<data> beaker --hosts hosts.yaml
 ```
 
 Beaker will populate the `vmhostname` property for each host using information provided by the AlwaysBeScheduling service.
+This is typically used in a CI scenario, where the jenkins run-me-maybe plugin is populating the ABS_RESOURCE_HOSTS variable.
+
+### Using vmfloaty
+
+If you do not specify a ABS_RESOURCE_HOSTS and request to provision via the beaker options, beaker-abs will fallback to using
+your vmfloaty configuration. By default it will look for the service named 'abs'. The name can also be configured via 
+the environment variable ABS_SERVICE_NAME or the top level option in the hosts file abs_service_name. Similarly, the priority defaults to "1" which means
+it will take precedence over CI tests. Be careful not to run a CI test with this option. The priority can be configured via
+the environment variable ABS_SERVICE_PRIORITY or the top level option in the hosts file abs_service_priority.
+
+#### Examples
+
+Changing from default priority 1 to 3 via env var
+```
+ABS_SERVICE_PRIORITY=3 bundle exec beaker --provision --hosts=hosts.cfg --tests acceptance/tests
+```
+
+Changing the service name to look for in ~/.vmfloaty.yml via a beaker option file
+```
+$ cat options.rb
+{
+  provision: 'true',
+  abs_service_name: "FOOBAR"
+}
+$ bundle exec beaker --hosts=hosts.cfg --tests acceptance/tests --options options.rb
+```
 
 ## Development
 

data/beaker-abs.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "beaker", "~> 4.0"
+  spec.add_dependency "vmfloaty", ">= 1.0", "< 2"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
 end

data/lib/beaker-abs/version.rb

@@ -1,5 +1,5 @@
 module BeakerAbs
   module Version
-    STRING = '0.4.0'
+    STRING = '0.9.0'
   end
 end

data/lib/beaker/hypervisor/abs.rb

@@ -1,7 +1,22 @@
 require 'beaker'
 require 'json'
+require 'pry-byebug'
+require 'vmfloaty'
+require 'vmfloaty/conf'
+require 'vmfloaty/utils'
 
 module Beaker
+  class Clifloaty
+    # the floaty service needs a 'cli' object that would normally represent the flags passed on the command line
+    # that object is then "merged" with the floaty config files to add/change options
+    # creating a dummy cli here
+    attr_reader :url, :token, :user, :service, :priority
+    def initialize(service, priority)
+      @service = service #the name of the service you want to use
+      @priority = priority
+    end
+  end
+
   class Abs < Beaker::Hypervisor
     def initialize(hosts, options)
       @options = options
@@ -9,7 +24,12 @@ module Beaker
       @hosts = hosts
 
       resource_hosts = ENV['ABS_RESOURCE_HOSTS'] || @options[:abs_resource_hosts]
-      raise ArgumentError.new("ABS_RESOURCE_HOSTS must be specified when using the Beaker::Abs hypervisor") if resource_hosts.nil?
+
+      @abs_service_name = ENV['ABS_SERVICE_NAME'] || @options[:abs_service_name] || "abs"
+      @abs_service_priority = ENV['ABS_SERVICE_PRIORITY'] || @options[:abs_service_priority] || "1"
+
+      raise ArgumentError.new("ABS_RESOURCE_HOSTS must be specified when using the Beaker::Abs hypervisor when provisioning") if resource_hosts.nil? && !options[:provision]
+      resource_hosts = provision_vms(hosts).to_json if resource_hosts.nil?
       @resource_hosts = JSON.parse(resource_hosts)
     end
 
@@ -21,8 +41,9 @@ module Beaker
             engine = resource_host['engine']
             case engine
             when /^(vmpooler|nspooler)$/
-              # putting ip last as its not set by ABS
-              return [:vmhostname, :hostname, :ip]
+              # ABS does not set ip, do not include
+              # vmpooler hostname is the platform name, nspooler hostname == vmhostname
+              return [:vmhostname]
             else
               super
             end
@@ -50,6 +71,7 @@ module Beaker
         type = resource_host['type']
         type2hosts[type] ||= []
         type2hosts[type] << resource_host['hostname']
+        type2hosts[type] << resource_host['ip']
       end
 
       # for each host, get a vm for that template type
@@ -60,6 +82,7 @@ module Beaker
 
         if provisioned_hosts = type2hosts[template]
           host['vmhostname'] = provisioned_hosts.shift
+          host['ip'] = provisioned_hosts.shift
         else
           raise ArgumentError.new("Failed to provision host '#{host.hostname}', no template of type '#{host['template']}' was provided.")
         end
@@ -72,5 +95,72 @@ module Beaker
     def cleanup
       # nothing to do
     end
+
+    def provision_vms(hosts)
+
+      verbose = false
+      config = Conf.read_config # get the vmfloaty config file in home dir
+
+      # TODO: the options object provided by the floaty cli is required in get_service_config()
+      cli = Clifloaty.new(@abs_service_name, @abs_service_priority)
+
+      #the service object is the interfacte to all methods
+      abs_service = Service.new(cli, config)
+      supported_vm_list = abs_service.list(verbose)
+      supported_vm_list = supported_vm_list.reject { |e| e.empty? }
+      supported_vm_list = supported_vm_list.reject { |e| e.start_with?("*") }
+
+      vm_request = generate_floaty_request_strings(hosts, supported_vm_list)
+
+
+      vm_beaker_abs = []
+      # Will return a JSON Object like this:
+      # {"redhat-7-x86_64"=>["rich-apparition.delivery.puppetlabs.net", "despondent-side.delivery.puppetlabs.net"], "centos-7-x86_64"=>["firmer-vamp.delivery.puppetlabs.net"]}
+      os_types = Utils.generate_os_hash(vm_request.split)
+      vm_floaty_output = abs_service.retrieve(verbose, os_types)
+
+
+      raise ArgumentError.new("Timed out getting the ABS resources") if vm_floaty_output.nil?
+      vm_floaty_output_cleaned = Utils.standardize_hostnames(vm_floaty_output)
+      vm_floaty_output_cleaned.each do |os_platform, value|
+        # filter any extra key that does not have an Array value
+        if !value.is_a?(Array)
+          next
+        end
+        value.each do | hostname |
+          # I don't think the engine is being used by the beaker-abs process
+          vm_beaker_abs.push({"hostname": hostname, "type": os_platform, "engine":"beaker-abs"})
+        end
+      end
+
+      # to do need to figure out what the NSPooler requests are, and combine the output for that with vm_beaker_abs and return that object
+      # for now just returning vmpooler abs object
+      vm_beaker_abs
+    end
+
+    # Based upon the host file, this method counts the number of each template needed
+    # and generates the host=Xnum eg redhat-7-x86_64=2 expected by floaty
+    def generate_floaty_request_strings(hosts, supported_vm_list)
+      vm_list = {}
+
+      hosts.each do |host|
+        if supported_vm_list.include?(host[:template])
+          if vm_list.include?(host[:template])
+            vm_list[host[:template]] = vm_list[host[:template]] + 1
+          else
+            vm_list[host[:template]] = 1
+          end
+        else
+          raise ArgumentError.new("#{host.name} has a template #{host[:template]} that is not found in vmpooler or nspooler")
+        end
+      end
+
+      vm_request = ""
+      vm_list.each do |key, value|
+        vm_request.concat("#{key}=#{value} ")
+      end
+
+      vm_request
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-abs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Josh Cooper
@@ -9,36 +9,70 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: beaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: vmfloaty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -62,12 +96,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".travis.yml"
+- CODEOWNERS
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
-- MAINTAINERS
 - README.md
 - Rakefile
 - beaker-abs.gemspec
@@ -93,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Let's test Puppet, using hosts provisioned by Always Be Scheduling service.

data/MAINTAINERS

@@ -1,17 +0,0 @@
-{
-  "version": 1,
-  "file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers",
-  "issues": "https://tickets.puppetlabs.com/browse/QENG/",
-  "people": [
-    {
-      "github": "joshcooper",
-      "email": "josh@puppet.com",
-      "name": "Josh Cooper"
-    },
-    {
-      "github": "rick",
-      "email": "rick@puppet.com",
-      "name": "Rick Bradley"
-    }
-  ]
-}