serverspec-extra-types 0.4.0 → 0.4.1

data/lib/serverspec-extra-types.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'serverspec_extra_types/version'
+require 'serverspec_extra_types/matchers'
+require 'serverspec_extra_types/types'

data/lib/serverspec_extra_types.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
-require 'serverspec_extra_types/version'
-require 'serverspec_extra_types/matchers'
-require 'serverspec_extra_types/types'
+puts "Deprecation WARNING: this file has been deprecated as the entry point to the gem. please use:"
+puts "require 'serverspec-extra-types'"
+
+require 'serverspec-extra-types'

data/lib/serverspec_extra_types/matchers.rb

@@ -30,6 +30,7 @@ require 'serverspec_extra_types/matchers/have_ha_nodes'
 require 'serverspec_extra_types/matchers/have_vhost'
 require 'serverspec_extra_types/matchers/have_ha_sync_mode'
 require 'serverspec_extra_types/matchers/mirror_all'
+require 'serverspec_extra_types/matchers/apply_to'
 require 'serverspec_extra_types/matchers/read_from_queue'
 require 'serverspec_extra_types/matchers/write_to_queue'
 require 'serverspec_extra_types/matchers/configure_queue'
@@ -39,4 +40,4 @@ require 'serverspec_extra_types/matchers/url_matchers'
 
 #--- sudo matchers
 require 'serverspec_extra_types/matchers/allowed_to_run_command'
-require 'serverspec_extra_types/matchers/allowed_to_run_anything'
+require 'serverspec_extra_types/matchers/allowed_to_run_anything'

data/lib/serverspec_extra_types/matchers/allowed_to_run_anything.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: false
+
 RSpec::Matchers.define :be_allowed_to_run_anything do
   chain :as do |user|
     @user = user
   end
   chain :as_anybody do
     @user = 'ALL'
+    @anybody = true
   end
   chain :without_password do
     @checkpw = true
@@ -20,19 +23,19 @@ RSpec::Matchers.define :be_allowed_to_run_anything do
   end
 
   failure_message do |actual|
-    msg = if  @user
-      "expected to be able to run anything as #{@user} got #{actual.permission('ALL')[:user]}"
-    else
-      "expected anything} to be in #{actual.permissions.map{|x| x[:command]}}"
+    msg = if @user
+            "expected to be able to run anything as #{@user} got #{actual.permission('ALL')[:user]}"
+          else
+            "expected 'ALL' to be in #{actual.permissions.map { |x| x[:command] }}"
     end
-    msg << %( without a password ) if @checkpw
+    msg << %( without a password) if @checkpw
     msg
   end
 
   description do
-    msg = "be allowed to run anything"
-    msg << %( as #{@user}) if @user
-    msg << %( without a password ) if @checkpw
+    msg = 'be allowed to run anything'
+    msg << %( as #{@anybody ? 'anybody' : "'#{@user}'"}) if @user
+    msg << %( without a password) if @checkpw
     msg
   end
-end
+end

data/lib/serverspec_extra_types/matchers/allowed_to_run_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 RSpec::Matchers.define :be_allowed_to_run_command do |command|
   chain :as do |user|
     @user = user
@@ -15,17 +17,17 @@ RSpec::Matchers.define :be_allowed_to_run_command do |command|
     if @user
       actual.allowed_to_run_command?(command, @user, @checkpw)
     elsif @anybody
-      (actual.allowed_to_run_command?(command, 'ALL', @checkpw) || actual.allowed_to_run_command?(command, 'ALL:ALL' ,@checkpw))
+      (actual.allowed_to_run_command?(command, 'ALL', @checkpw) || actual.allowed_to_run_command?(command, 'ALL:ALL', @checkpw))
     else
       actual.allowed_to_run_command?(command, @checkpw)
     end
   end
 
   failure_message do |actual|
-    msg = if  @user
-      "expected to be able to run #{command} as #{@user} got #{actual.permission(command)[:user]}"
-    else
-      "expected #{command} to be in #{actual.permissions.map{|x| x[:command]}}"
+    msg = if @user
+            "expected to be able to run #{command} as #{@user} got #{actual.permission(command)[:user]}"
+          else
+            "expected #{command} to be in #{actual.permissions.map { |x| x[:command] }}"
     end
     msg << %( without a password ) if @checkpw
     msg
@@ -37,4 +39,4 @@ RSpec::Matchers.define :be_allowed_to_run_command do |command|
     msg << %( without a password ) if @checkpw
     msg
   end
-end
+end

data/lib/serverspec_extra_types/matchers/apply_to.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :apply_to do |arg|
+  match do |actual|
+    actual.apply_to?(arg)
+  end
+end

data/lib/serverspec_extra_types/matchers/have_host.rb

@@ -3,7 +3,11 @@
 RSpec::Matchers.define :have_host do |host|
   match do |actual|
     if !@option
-      actual.has_host? host
+      if !@options
+        actual.has_host? host
+      else
+        actual.has_host? host, @option
+      end
     else
       actual.has_host? host, @option
     end
@@ -11,13 +15,16 @@ RSpec::Matchers.define :have_host do |host|
   description do
     msg = "have #{host}"
     msg << " with option #{@option}" if @option
+    msg << " with options #{@options}" if @options
     msg
   end
   failure_message do |actual|
     msg = "expected #{actual.hosts} to contain #{host}"
     msg << " with option '#{@option}'" if @option
+    msg << " with options '#{@options}'" if @options
     msg
   end
 
   chain :with_option, :option
+  chain :with_options, :options
 end

data/lib/serverspec_extra_types/matchers/have_image.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :have_image do |image|

data/lib/serverspec_extra_types/matchers/have_label.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 RSpec::Matchers.define :be_labeled do |label|
-
-
   match do |actual|
     if !@value
       actual.labels.key? label
@@ -31,4 +29,4 @@ RSpec::Matchers.define :be_labeled do |label|
   end
 end
 RSpec::Matchers.alias_matcher :have_label, :be_labeled
-RSpec::Matchers.alias_matcher :be_labelled, :be_labeled
+RSpec::Matchers.alias_matcher :be_labelled, :be_labeled

data/lib/serverspec_extra_types/types/api_base.rb

@@ -26,7 +26,6 @@ module Serverspec::Type
       @url_base
     end
 
-
     def inspection
       @inspection ||= ::MultiJson.load(get_inspection.stdout)
     end
@@ -34,16 +33,18 @@ module Serverspec::Type
     private
 
     def extra_args
-      ""
+      ''
     end
 
     def curl_command
       "curl #{extra_args} -s #{url} #{@insecure ? '-k' : ''} #{@redirects ? '-L' : ''}"
     end
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       command = curl_command
       @get_inspection ||= @runner.run_command(command)
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/consul_base.rb

@@ -28,6 +28,8 @@ module Serverspec::Type
     end
 
     def inspection
+      puts get_inspection.stdout
+      puts get_inspection.stderr
       @inspection ||= ::MultiJson.load(get_inspection.stdout)[0]
     end
 
@@ -37,10 +39,12 @@ module Serverspec::Type
       @token ? "--header 'X-Consul-Token: #{@token}'" : ''
     end
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
-
       command = curl_command
       @get_inspection ||= @runner.run_command(command)
     end
+    # rubocop:enable Naming/AccessorMethodName
+
   end
 end

data/lib/serverspec_extra_types/types/consul_node_list.rb

@@ -20,7 +20,7 @@ module Serverspec::Type
     end
 
     def nodes
-      inspection.map { |node| node['Node']}
+      inspection.map { |node| node['Node'] }
     end
 
     def inspection

data/lib/serverspec_extra_types/types/consul_service.rb

@@ -19,7 +19,6 @@ module Serverspec::Type
       @inspection ||= ::MultiJson.load(get_inspection.stdout)[0]
     end
 
-
     ##= Generated Code Start =##
     # TODO: Make these better
     # Key Type: String
@@ -63,7 +62,7 @@ module Serverspec::Type
       inspection['TaggedAddresses']
     end
 
-    # Todo: do method for indiviual tagged addresses
+    # TODO: do method for indiviual tagged addresses
     def has_tagged_addresses?(tagged_addresses)
       self.tagged_addresses == tagged_addresses
     end
@@ -127,7 +126,7 @@ module Serverspec::Type
       inspection['ServiceWeights']
     end
 
-    # Todo: do method for indiviual service weight are well as passing/warning
+    # TODO: do method for indiviual service weight are well as passing/warning
     def has_service_weights?(service_weights)
       self.service_weights == service_weights
     end
@@ -204,6 +203,5 @@ module Serverspec::Type
       self.modify_index == modify_index
     end
     ##= Generated Code End   =##
-
   end
 end

data/lib/serverspec_extra_types/types/curl.rb

@@ -48,6 +48,7 @@ module Serverspec::Type
       "-w \"#{output_format}\""
     end
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       command = curl_command
       unless @get_inspection
@@ -59,6 +60,7 @@ module Serverspec::Type
 
       @get_inspection
     end
+    # rubocop:enable Naming/AccessorMethodName
 
     def output_format
       out = '!!SS_URL_YAML!!---\\n'

data/lib/serverspec_extra_types/types/docker_config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'base64'
 module Serverspec::Type
   class DockerConfig < DockerBase
@@ -15,7 +16,7 @@ module Serverspec::Type
     end
 
     def has_data64?(data)
-      self.data64 == data
+      data64 == data
     end
 
     def data64
@@ -48,8 +49,10 @@ module Serverspec::Type
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @get_inspection ||= @runner.run_command("docker config inspect #{@name}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/docker_container.rb

@@ -118,9 +118,11 @@ module Serverspec::Type
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @containers ||= @name.include?('=') ? @runner.run_command("docker ps -qa -f #{@name}").stdout : @name
       @get_inspection ||= @runner.run_command("docker inspect #{@containers}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/docker_network.rb

@@ -3,9 +3,7 @@
 require 'serverspec'
 
 module Serverspec::Type
-
   class DockerNetwork < DockerBase
-
     def name
       inspection['Name']
     end
@@ -35,11 +33,11 @@ module Serverspec::Type
     end
 
     def overlay?
-      self.has_driver? 'overlay'
+      has_driver? 'overlay'
     end
 
     def bridge?
-      self.has_driver? 'bridge'
+      has_driver? 'bridge'
     end
 
     def driver
@@ -66,9 +64,11 @@ module Serverspec::Type
       inspection['Labels']
     end
 
+    # rubocop:disable Naming/MethodName
     def IPv6_enabled?
       inspection['EnableIPv6']
     end
+    # rubocop:enable Naming/MethodName
 
     def internal?
       inspection['Internal']
@@ -88,8 +88,10 @@ module Serverspec::Type
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @get_inspection ||= @runner.run_command("docker network inspect #{@name}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/docker_node.rb

@@ -14,7 +14,6 @@ module Serverspec::Type
       availability == 'pause'
     end
 
-
     def availability
       inspection['Spec']['Availability']
     end
@@ -46,10 +45,13 @@ module Serverspec::Type
     def exist?
       get_inspection.success?
     end
+
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @get_inspection ||= @runner.run_command("docker node inspect #{@name}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/docker_secret.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'base64'
 module Serverspec::Type
   class DockerSecret < DockerBase
@@ -15,10 +16,9 @@ module Serverspec::Type
     end
 
     def has_data64?(data)
-      self.data64 == data
+      data64 == data
     end
 
-
     def data64
       inspection['Spec']['Data']
     end
@@ -49,8 +49,10 @@ module Serverspec::Type
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @get_inspection ||= @runner.run_command("docker secret inspect #{@name}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/serverspec_extra_types/types/docker_service.rb

@@ -75,7 +75,7 @@ module Serverspec::Type
 
     def has_secret?(name, target = nil)
       if target
-        secrets.find { |secret| secret['SecretName'] == name && secret['File']['Name'] == target}
+        secrets.find { |secret| secret['SecretName'] == name && secret['File']['Name'] == target }
       else
         secrets.find { |secret| secret['SecretName'] == name }
       end
@@ -168,9 +168,11 @@ module Serverspec::Type
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
       @get_inspection ||= @runner.run_command("docker service inspect #{@name}")
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end
 

data/lib/serverspec_extra_types/types/jenkins_base.rb

@@ -18,6 +18,5 @@ module Serverspec::Type
     def exist?
       get_inspection.success?
     end
-
   end
 end

data/lib/serverspec_extra_types/types/jenkins_credential.rb

@@ -30,17 +30,14 @@ module Serverspec::Type
       end
     end
 
-
     def ssh_private_key?
       inspection['typeName'] == 'SSH Username with private key'
     end
 
-
     def gitlab_api_token?
       inspection['typeName'] == 'GitLab API token'
     end
 
-
     def aws_credential?
       inspection['typeName'] == 'AWS Credentials'
     end
@@ -57,16 +54,18 @@ module Serverspec::Type
       inspection['description'] == desc
     end
 
-    def has_display_text?(text)
-      inspection['displayText'] == text
+    def has_display_name?(text)
+      inspection['displayName'] == text
     end
 
     private
 
+    # rubocop:disable Naming/AccessorMethodName
     def get_inspection
-      userpass = @user ? "-u #{@user}:#{@password}" : ""
+      userpass = @user ? "-u #{@user}:#{@password}" : ''
       command = "curl -s  #{userpass} #{url} #{@insecure ? '-k' : ''} #{@redirects ? '-L' : ''}"
       @get_inspection ||= @runner.run_command(command)
     end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end