serverspec-extra-types 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2abeaee406277bcf2ba5645d062647dfe4f9488fcd8c905459a1d52e2f3a4fa
-  data.tar.gz: 43b87999802efc74e3b93c870a6a714bf743d5fae8ccf534c1f64bdc6adff1cd
+  metadata.gz: 6fa7e592e8372304d35d02542def418d190d43fb780566c21c99769cc72bcef1
+  data.tar.gz: d114bf6691afdc377f9b510f34c49d0fc2aac0200e5cc3315bc89a55afa53051
 SHA512:
-  metadata.gz: 01dad3872b4584935d104e0dce1f36bd385cd2fe515079a3008f498a51cd636d9b120fb2aad103a1386af7676f111b6fe269ddb3629096200e7406febffb8134
-  data.tar.gz: d3dfbc51d3b260b342d3480ebd9000b5e4d0144535a100340e611754eabf3eec729f77bfe904e049df410f27b6bb66efa5f9a27c8b57c6e46fd2b78360cb525b
+  metadata.gz: 3314cbfb00b930aedbc74624e76010df186de9db54793b988b6c94cc6d0e89f173dc7b17ec01aa4a309de608f4a4ae543739268730db4e163ca14e14b3016cc6
+  data.tar.gz: b5c7335d7f3701a1b63397cb7680db498e698fbb115ffa144b19e42496df9335e4edb142b61772296dedc7f49636d3d73fb207d39a764c70d31c40108fc69fb4

data/.rubocop.yml

@@ -2,5 +2,18 @@ AllCops:
   Exclude:
     - 'serverspec-extra-types.gemspec'
 
-Metric/LineLength:
-  Max: 120
+tyle/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 140
+
+
+Metrics/MethodLength:
+ Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/lib/serverspec_extra_types/helpers/properties.rb

@@ -4,8 +4,8 @@ rabbitmq_user = ENV['RABBITMQ_USER'] || 'guest'
 rabbitmq_password = ENV['RABBITMQ_PASSWORD'] || 'guest'
 rabbitmq_url = ENV['RABBITMQ_URL'] || 'http://localhost:15672'
 props = {
-  rabbitmq_user: rabbitmq_user,
-  rabbitmq_password: rabbitmq_password,
-  rabbitmq_url: rabbitmq_url
+  rabbitmq_user: property[:rabbitmq_user] || rabbitmq_user,
+  rabbitmq_password: property[:rabbitmq_password] || rabbitmq_password,
+  rabbitmq_url: property[:rabbitmq_url] || rabbitmq_url
 }
-set_property props
+set_property property.merge(props)

data/lib/serverspec_extra_types/matchers.rb

@@ -1,4 +1,3 @@
-
 #--- Docker Matchers
 require 'serverspec_extra_types/matchers/be_active'
 require 'serverspec_extra_types/matchers/be_a_manager_node'
@@ -9,6 +8,7 @@ require 'serverspec_extra_types/matchers/have_placement_constraint'
 require 'serverspec_extra_types/matchers/have_hostname'
 require 'serverspec_extra_types/matchers/have_host'
 require 'serverspec_extra_types/matchers/have_image'
+require 'serverspec_extra_types/matchers/have_label'
 require 'serverspec_extra_types/matchers/have_image_sha'
 require 'serverspec_extra_types/matchers/have_restart_limit'
 require 'serverspec_extra_types/matchers/have_restart_policy'

data/lib/serverspec_extra_types/matchers/be_a_manager_node.rb

@@ -12,4 +12,4 @@ end
 
 RSpec::Matchers.alias_matcher :be_manager, :be_a_manager_node
 RSpec::Matchers.alias_matcher :be_a_manager, :be_a_manager_node
-RSpec::Matchers.alias_matcher :be_manager_node, :be_a_manager_node
+RSpec::Matchers.alias_matcher :be_manager_node, :be_a_manager_node

data/lib/serverspec_extra_types/matchers/be_a_worker_node.rb

@@ -11,4 +11,4 @@ RSpec::Matchers.define :be_a_worker_node do
 end
 RSpec::Matchers.alias_matcher :be_worker, :be_a_worker_node
 RSpec::Matchers.alias_matcher :be_a_worker, :be_a_worker_node
-RSpec::Matchers.alias_matcher :be_worker_node, :be_a_worker_node
+RSpec::Matchers.alias_matcher :be_worker_node, :be_a_worker_node

data/lib/serverspec_extra_types/matchers/be_active.rb

@@ -1,7 +1,5 @@
 RSpec::Matchers.define :be_active do
-  match do |actual|
-    actual.active?
-  end
+  match(&:active?)
   failure_message do |actual|
     "expected '#{actual.availability}' to be active"
   end

data/lib/serverspec_extra_types/matchers/configure_queue.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :configure_queue do |vhost, queue|
   match do |actual|
-   actual.configure_queue? vhost, queue
+    actual.configure_queue? vhost, queue
   end
   description do
     "be able configure #{queue} on the #{vhost} vhost"

data/lib/serverspec_extra_types/matchers/have_count.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :have_count do |count|
   match do |actual|
-    actual.length ==  count
+    actual.length == count
   end
   description do
     "have #{count}"
@@ -8,4 +8,4 @@ RSpec::Matchers.define :have_count do |count|
   failure_message do |actual|
     "expected count to be #{count} was #{actual.length}"
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_engine_version.rb

@@ -8,4 +8,4 @@ RSpec::Matchers.define :have_engine_version do |version|
   description do
     "be running docker version #{version}"
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_environment_variable.rb

@@ -1,5 +1,5 @@
 RSpec::Matchers.define :have_environment_variable do |regex|
-  chain :with_value do | value|
+  chain :with_value do |value|
     @value = value
   end
   match do |actual|
@@ -17,5 +17,4 @@ RSpec::Matchers.define :have_environment_variable do |regex|
       "expected #{regex} to have value #{@value}, it was #{actual.environment_variable(regex)}"
     end
   end
-
 end

data/lib/serverspec_extra_types/matchers/have_ha_sync_mode.rb

@@ -2,4 +2,4 @@ RSpec::Matchers.define :have_ha_sync_mode do |mode|
   match do |actual|
     actual.has_ha_sync_mode? mode
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_label.rb

@@ -1,20 +1,27 @@
 RSpec::Matchers.define :have_label do |label|
-  match do |actual|
-    actual.labels.key? label
-  end
-  failure_message do |actual|
-    "expected #{actual.labels} to have key #{label}"
+  chain :with_value do |_value|
+    @value = _value
   end
-end
 
-RSpec::Matchers.define :have_label_with_value do |label, value|
   match do |actual|
-    actual.labels[label] == value
-  end
-  failure_message do |actual|
-    "expected #{actual.labels[label]} to be #{value}"
+    if !@value
+      actual.labels.key? label
+    else
+      actual.has_label?(label, @value)
+    end
   end
   description do
-    "have label #{label} with value #{value}"
+    if !@value
+      "have label #{label}"
+    else
+      "have label #{label} with value #{@value}"
+      end
+  end
+  failure_message do |actual|
+    if !@value
+      "expected #{actual.labels} to have key #{label}"
+    else
+      "expected #{actual.label(label)[0]} to have value #{@value}, it had #{actual.label(label)[1]} "
+    end
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_mount.rb

@@ -1,11 +1,15 @@
-RSpec::Matchers.define :have_mount do |source, target, type = 'bind'|
+RSpec::Matchers.define :have_mount do |source, target|
+  chain :type, :type
   match do |actual|
-    actual.has_mount?(source, target, type)
+    @type ||= source.include?('/') ? 'bind' : 'volume'
+    actual.has_mount?(source, target, @type)
   end
   description do
-    "mount #{source} on host to #{target} in container as a #{type} mount"
+    @type ||= source.include?('/') ? 'bind' : 'volume'
+    "#{@type == 'bind' ? 'bind' : 'mount volume'} #{source} on host to #{target} in container"
   end
   failure_message do |actual|
-    "expected #{actual.mounts} to contain {'Target' => #{target}, 'Destination' => #{source} , 'Type' => #{type}}"
+    @type ||= source.include?('/') ? 'bind' : 'volume'
+    "expected #{actual.mounts} to contain {'Target' => #{target}, 'Source' => #{source}, 'Type' => #{@type}}"
   end
 end

data/lib/serverspec_extra_types/matchers/have_network.rb

@@ -5,4 +5,4 @@ RSpec::Matchers.define :have_network do |name|
   failure_message do |actual|
     "expected #{actual.networks} to include #{name}"
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_placement_constraint.rb

@@ -5,4 +5,4 @@ RSpec::Matchers.define :have_placement_constraint do |constraint|
   failure_message do |actual|
     "expected #{actual.placement_constraint} to include #{constraint}"
   end
-end
+end

data/lib/serverspec_extra_types/matchers/have_user.rb

@@ -7,4 +7,4 @@ RSpec::Matchers.define :have_user do |user|
   end
 end
 
-RSpec::Matchers.alias_matcher :run_as_user, :have_user
+RSpec::Matchers.alias_matcher :run_as_user, :have_user

data/lib/serverspec_extra_types/matchers/map_port.rb

@@ -1,7 +1,6 @@
 RSpec::Matchers.define :map_port do |host, container|
-
   match do |actual|
-    @protocol = 'tcp' unless @protocol
+    @protocol ||= 'tcp'
     if @mode
       actual.map_port? host, container, @protocol, @mode
     else
@@ -15,11 +14,10 @@ RSpec::Matchers.define :map_port do |host, container|
     msg
   end
   failure_message do |actual|
-    @protocol = 'tcp' unless @protocol
+    @protocol ||= 'tcp'
     "expected #{actual.port_map} to contain {\"#{container}/#{@protocol}\"=>[{\"HostPort\"=>\"#{host}\"}] }"
   end
 
   chain :using_protocol, :protocol
   chain :with_mode, :mode
-
-end
+end

data/lib/serverspec_extra_types/matchers/mirror_all.rb

@@ -1,5 +1,3 @@
 RSpec::Matchers.define :mirror_all do
-  match do |actual|
-    actual.mirror_all?
-  end
-end
+  match(&:mirror_all?)
+end

data/lib/serverspec_extra_types/matchers/publish_all_ports.rb

@@ -1,3 +1,3 @@
 RSpec::Matchers.define :publish_all_ports do
-  match { |actual| actual.publishes_all_ports? }
+  match(&:publishes_all_ports?)
 end

data/lib/serverspec_extra_types/types/consul_node.rb

@@ -1,20 +1,14 @@
 require 'serverspec_extra_types/types/consul_base'
 
-
 # TODO: List and singular
 module Serverspec::Type
   class ConsulNode < ConsulBase
-
     def url
       "#{@url_base}/v1/catalog/node/#{@name}"
     end
 
-
-
     def inspection
-      @inspection ||= ::MultiJson.load(get_inspection.stdout) #Need a find
+      @inspection ||= ::MultiJson.load(get_inspection.stdout) # Need a find
     end
-
-
   end
 end

data/lib/serverspec_extra_types/types/consul_node_list.rb

@@ -1,20 +1,18 @@
 require 'serverspec_extra_types/types/consul_base'
 
-
 # TODO: List and singular
 module Serverspec::Type
   class ConsulNodeList < ConsulBase
-
     def url
       "#{@url_base}/v1/catalog/nodes"
     end
 
     def to_s
-      msg = "Consul Node List"
+      msg = 'Consul Node List'
       msg << %( with acl token: "#{@token}") if @token
       msg
     end
-    
+
     def has_node?(node)
       nodes.include? node
     end
@@ -26,7 +24,5 @@ module Serverspec::Type
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
-
   end
 end

data/lib/serverspec_extra_types/types/consul_service.rb

@@ -1,10 +1,8 @@
 require 'serverspec_extra_types/types/consul_base'
 
-
 # TODO: List and singular
 module Serverspec::Type
   class ConsulService < ConsulBase
-
     def url
       "#{@url_base}/v1/catalog/service/#{@name}"
     end
@@ -18,7 +16,5 @@ module Serverspec::Type
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
-
   end
 end

data/lib/serverspec_extra_types/types/consul_service_list.rb

@@ -1,16 +1,14 @@
 require 'serverspec_extra_types/types/consul_base'
 
-
 # TODO: List and singular
 module Serverspec::Type
   class ConsulServiceList < ConsulBase
-
     def url
       "#{@url_base}/v1/catalog/services"
     end
 
     def to_s
-      msg = "Consul Service List"
+      msg = 'Consul Service List'
       msg << %( with acl token: "#{@token}") if @token
       msg
     end
@@ -26,7 +24,5 @@ module Serverspec::Type
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
-
   end
 end

data/lib/serverspec_extra_types/types/docker_container.rb

@@ -12,7 +12,7 @@ module Serverspec::Type
     end
 
     def has_image_sha?(image)
-      self.image_sha == image
+      image_sha == image
     end
 
     def image
@@ -29,7 +29,6 @@ module Serverspec::Type
       else
         environment_variable(regex)
       end
-
     end
 
     def environment_variable(regex)
@@ -57,7 +56,7 @@ module Serverspec::Type
     end
 
     def has_domainname?(domain)
-      self.domain_name == domain
+      domain_name == domain
     end
 
     def domain_name
@@ -79,11 +78,13 @@ module Serverspec::Type
     def restart_policy
       inspection['HostConfig']['RestartPolicy']['Name']
     end
+
     def has_host?(host)
       hosts.include? host
     end
+
     def hosts
-      inspection['HostConfig']['ExtraHosts'].map {|itm| itm.split(':')[1] + ' ' + itm.split(':')[0]}
+      inspection['HostConfig']['ExtraHosts'].map { |itm| itm.split(':')[1] + ' ' + itm.split(':')[0] }
     end
 
     def privileged?
@@ -95,7 +96,6 @@ module Serverspec::Type
       inspection['HostConfig']['PublishAllPorts']
     end
 
-
     def map_port?(host, container, protocol = 'tcp')
       inspection['NetworkSettings']['Ports']["#{container}/#{protocol}"][0]['HostPort'] == host
     end
@@ -117,7 +117,7 @@ module Serverspec::Type
     private
 
     def get_inspection
-      @containers ||=  @name.include?('=') ? @runner.run_command("docker ps -qa -f #{@name}").stdout : @name
+      @containers ||= @name.include?('=') ? @runner.run_command("docker ps -qa -f #{@name}").stdout : @name
       @get_inspection ||= @runner.run_command("docker inspect #{@containers}")
     end
   end

data/lib/serverspec_extra_types/types/docker_network.rb

@@ -0,0 +1,22 @@
+require 'serverspec'
+
+module Serverspec::Type
+  # This class  monkey patches serverspec's docker container type with some more method to be used in matchers
+  class DockerNetwork < DockerBase
+
+    def name
+      inspection['Name']
+    end
+
+    def id
+      inspection['Id']
+    end
+
+    private
+
+
+    def get_inspection
+      @get_inspection ||= @runner.run_command("docker network inspect #{@name}")
+    end
+  end
+end

data/lib/serverspec_extra_types/types/docker_node.rb

@@ -1,6 +1,5 @@
 module Serverspec::Type
   class DockerNode < DockerBase
-
     def active?
       availability == 'active'
     end
@@ -32,10 +31,11 @@ module Serverspec::Type
     def engine_version
       inspection['Description']['Engine']['EngineVersion']
     end
+
     private
 
     def get_inspection
-      @get_inspection ||= @runner.run_command("docker service inspect #{@name}")
+      @get_inspection ||= @runner.run_command("docker node inspect #{@name}")
     end
   end
 end

data/lib/serverspec_extra_types/types/docker_service.rb

@@ -1,6 +1,7 @@
 require 'serverspec'
 require 'serverspec/type/base'
 require 'serverspec/type/docker_base'
+require 'serverspec_extra_types/types/docker_network'
 
 module Serverspec::Type
   class DockerService < DockerBase
@@ -58,6 +59,26 @@ module Serverspec::Type
       inspection['Spec']['TaskTemplate']['ContainerSpec']['Mounts']
     end
 
+    def has_config?(name, target = nil)
+      if target
+        configs.find { |config| config['ConfigName'] == name && config['File']['Name'] == target }
+      else
+        configs.find { |config| config['ConfigName'] == name }
+      end
+    end
+
+    def configs
+      inspection['Spec']['TaskTemplate']['ContainerSpec']['Configs']
+    end
+
+    def has_secret?(name)
+      secrets.find { |secret| secret['SecretName'] == name }
+    end
+
+    def secrets
+      inspection['Spec']['TaskTemplate']['ContainerSpec']['Secrets']
+    end
+
     def has_host?(host)
       hosts.include? host
     end
@@ -78,9 +99,6 @@ module Serverspec::Type
       inspection['Spec']['Mode']['Replicated']
     end
 
-    def replicas
-      ['Spec']['Mode']['Replicated']['Replicas']
-    end
     def global?
       inspection['Spec']['Mode']['Global']
     end
@@ -94,14 +112,15 @@ module Serverspec::Type
     end
 
     def has_network?(name)
-      networks.find { |network| network['Aliases'].include? name }
+      target_network = DockerNetwork.new(name)
+      networks.find { |network| network['Target'].include? target_network.id }
     end
 
     def port_map
       inspection['Spec']['EndpointSpec']['Ports']
     end
 
-    def map_port?(published, target, protocol = 'tcp',mode = 'ingress')
+    def map_port?(published, target, protocol = 'tcp', mode = 'ingress')
       port_map.find do |port|
         port['PublishedPort'] == published.to_i &&
           port['TargetPort'] == target.to_i && port['PublishMode'] == mode &&
@@ -109,6 +128,37 @@ module Serverspec::Type
       end
     end
 
+    def has_environment_variable?(regex, value = nil)
+      if value
+        environment_variable(regex) == value
+      else
+        environment_variable(regex)
+      end
+    end
+
+    def environment_variable(regex)
+      environment_variables.find { |str| str =~ /^#{regex}=/ }.split('=')[1]
+    end
+
+    def environment_variables
+      inspection['Spec']['TaskTemplate']['ContainerSpec']['Env']
+    end
+
+    def has_label?(label, value = nil)
+      if value
+        label(label)[1] == value
+      else
+        label(label)
+      end
+    end
+
+    def label(label)
+      labels.find { |key, _val| key == label }
+    end
+
+    def labels
+      inspection['Spec']['Labels']
+    end
 
     private
 

data/lib/serverspec_extra_types/types/rabbitmq_base.rb

@@ -13,7 +13,6 @@ module Serverspec::Type
       @url_base = property[:variables][:rabbitmq_url] || 'http://localhost:15672'
     end
 
-
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)[0]
     end
@@ -21,7 +20,7 @@ module Serverspec::Type
     def length
       if inspection.is_a? String
         inspection.length
-      elsif inspection.kind_of? Array
+      elsif inspection.is_a? Array
         inspection.length
       else
         1

data/lib/serverspec_extra_types/types/rabbitmq_node_list.rb

@@ -1,18 +1,13 @@
 require 'serverspec_extra_types/types/rabbitmq_base'
 
 module Serverspec::Type
-  class RabbitmqNodeList   < RabbitmqBase
-
+  class RabbitmqNodeList < RabbitmqBase
     def url
       "#{@url_base}/api/vhosts"
     end
 
-
-
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
-
   end
 end

data/lib/serverspec_extra_types/types/rabbitmq_user_permission.rb

@@ -2,7 +2,6 @@ require 'serverspec_extra_types/types/rabbitmq_base'
 
 module Serverspec::Type
   class RabbitmqUserPermission < RabbitmqBase
-
     def url
       "#{@url_base}/api/users/#{name}/permissions"
     end
@@ -20,20 +19,19 @@ module Serverspec::Type
     end
 
     def read_permissions(vhost)
-      inspection.find { |item| item['vhost'] == vhost}['read']
+      inspection.find { |item| item['vhost'] == vhost }['read']
     end
 
     def write_permissions(vhost)
-      inspection.find { |item| item['vhost'] == vhost}['write']
+      inspection.find { |item| item['vhost'] == vhost }['write']
     end
 
     def configure_permissions(vhost)
-      inspection.find { |item| item['vhost'] == vhost}['configure']
+      inspection.find { |item| item['vhost'] == vhost }['configure']
     end
 
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
   end
 end

data/lib/serverspec_extra_types/types/rabbitmq_vhost_list.rb

@@ -1,11 +1,9 @@
 require 'serverspec_extra_types/types/rabbitmq_base'
 
 module Serverspec::Type
-  class RabbitmqVhostList   < RabbitmqBase
-
-
+  class RabbitmqVhostList < RabbitmqBase
     def has_vhost?(vhost)
-     inspection.find { |str| str['name'] == vhost }
+      inspection.find { |str| str['name'] == vhost }
     end
 
     def url
@@ -15,8 +13,5 @@ module Serverspec::Type
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
-
-
-
   end
 end

data/lib/serverspec_extra_types/types/rabbitmq_vhost_policy.rb

@@ -2,7 +2,6 @@ require 'serverspec_extra_types/types/rabbitmq_base'
 
 module Serverspec::Type
   class RabbitmqVhostPolicy < RabbitmqBase
-
     def initialize(name = nil, vhost = nil, options = {})
       super(name, options)
       @vhost = vhost

data/lib/serverspec_extra_types/version.rb

@@ -1,3 +1,3 @@
 module ServerspecExtraTypes
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-extra-types
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Wardrobe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,6 +195,7 @@ files:
 - lib/serverspec_extra_types/types/consul_service.rb
 - lib/serverspec_extra_types/types/consul_service_list.rb
 - lib/serverspec_extra_types/types/docker_container.rb
+- lib/serverspec_extra_types/types/docker_network.rb
 - lib/serverspec_extra_types/types/docker_node.rb
 - lib/serverspec_extra_types/types/docker_service.rb
 - lib/serverspec_extra_types/types/rabbitmq_base.rb
@@ -225,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Additional Types and Matchers for Serverspec