serverspec-extended-types 0.0.3 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Yzc2OWUzM2M5NDljNTNkM2I1ZjE5ZWUwYjZlMzUzM2NhNTAyYjliMg==
-  data.tar.gz: !binary |-
-    OGRiMjQ5NWZhNGMxZjg4MzQ2ZmM0MDA1MTllM2M4NDUzZWE5ZWU4Yw==
+SHA1:
+  metadata.gz: 7323a24b2db29288fb1c5b48d10444b3febf582d
+  data.tar.gz: 8c6cc0312da2d38b244a933cba6b930c6f67d779
 SHA512:
-  metadata.gz: !binary |-
-    YWE2ZWRlOGZmNzlkZjM0OWIwODZhODUwMmQzNzkxNjYwYWJjYjFhZWUxNTYw
-    ZjA0NmVjNTkzYmQ5OTI3ZjA4ZDFkYjIxZTQwM2NjNzE0ZjNiNjJhMDAzNjBm
-    NzkzYjY3NDE4NDcwZGNkNmQzMmQ0ZGFjY2EzZTcxYWQ4OTQ5YzY=
-  data.tar.gz: !binary |-
-    OWFhMTJmOTE5YzU3NDI3ODZmNTZkZjQyNGFhMTk4NzQ4MjZmMDQ3Yzc0ODRi
-    ZTUzMTJkMmM5YjFjYzllNjZhMWQ2ZWY1MmQwNjQ0YzU3ZGIwMWVlNTgyNjc0
-    YzM1ODRkYTRjYzZhOWVmMmRjMGJmZjY4NTJlNzEwMDM0NTY1NmQ=
+  metadata.gz: de53147b38a00edfd945ed14569e0713fc2045b11ab798cfb1a0431e9fafa4df904f0fcce1256204ed64fcd3d23340ff9d3fe5e3772c9d3347b02bf9fcb4f57d
+  data.tar.gz: 64026f353890298a85bb60b59e0fb2dfe288e042166936002c4fe7938862a72f1f454130398dc19c2c9eeb7f6c64233376b2eba7e90e0d04aafd6af519daea58

data/CHANGES.md

@@ -1,5 +1,9 @@
 # serverspec-extended-types, changelog
 
+## 0.1.0 2017-05-15 Jason Antman <jason@jasonantman.com>
+
+* Add `protocol` (http|https) and `bypass_ssl_verify` parameters for http_get.
+
 ## 0.0.3 2015-03-23 Jason Antman <jason@jasonantman.com>
 
 * Add ``json`` matcher for http_get type.

data/README.md

@@ -109,7 +109,7 @@ The http_get type performs an HTTP GET from the local (rspec runner) system, aga
 the IP address that serverspec is running against (``ENV[TARGET_HOST]``), with a
 specified ``Host`` header value. The request is wrapped in a configurable-length timeout.
 
-    describe http_get(port, host_header, path, timeout_sec=10)
+    describe http_get(port, host_header, path, timeout_sec=10, protocol='http', bypass_ssl_verify=false)
       # matchers here
 	end
 
@@ -123,6 +123,8 @@ state variables for later use by the various matchers.
 * __host_header__ - the ``Host`` header value to provide in the request
 * __path__ - the path to request from the server
 * __timeout_sec__ - timeout in seconds before canceling the request (Int; default 10)
+* __protocol__ - protocol to be used (default to `http`,  can be `http`)
+* __bypass_ssl_verify__ - bypass SSL verification (default to `false` to keep good security. Set it to `true` for self-signed certificates only!)
 
 #### Matchers
 

data/lib/serverspec_extended_types/http_get.rb

@@ -30,6 +30,8 @@ module Serverspec
       # @param host_header [String] the value to set in the 'Host' HTTP request header
       # @param path [String] the URI/path to request from the server
       # @param timeout_sec [Int] how many seconds to allow request to run before timing out and setting @timed_out_status to True
+      # @param protocol [String] the protocol to connect to the server (e.g. 'http', 'https')
+      # @param bypass_ssl_verify [Boolean] if true, SSL verification will be bypassed (useful for self-signed certificates)
       #
       # @example
       #   describe http_get(80, 'myhostname', '/') do
@@ -38,7 +40,7 @@ module Serverspec
       #
       # @api public
       # @return [nil]
-      def initialize(port, host_header, path, timeout_sec=10)
+      def initialize(port, host_header, path, timeout_sec=10, protocol='http', bypass_ssl_verify=false)
         @ip = ENV['TARGET_HOST']
         @port = port
         @host = host_header
@@ -48,6 +50,8 @@ module Serverspec
         @headers_hash = nil
         @response_code_int = nil
         @response_json = nil
+        @protocol = protocol
+        @bypass_ssl_verify = bypass_ssl_verify
         begin
           Timeout::timeout(timeout_sec) do
             getpage
@@ -66,7 +70,10 @@ module Serverspec
       def getpage
         ip = @ip
         port = @port
-        conn = Faraday.new("http://#{ip}:#{port}/")
+        protocol = @protocol
+        options = []
+        options << { ssl: { verify: false } } if @bypass_ssl_verify
+        conn = Faraday.new("#{protocol}://#{ip}:#{port}/", *options)
         version = ServerspecExtendedTypes::VERSION
         conn.headers[:user_agent] = "Serverspec::Type::Http_Get/#{version} (https://github.com/jantman/serverspec-extended-types)"
         conn.headers[:Host] = @host
@@ -168,11 +175,13 @@ module Serverspec
     # @param host_header [String] the value to set in the 'Host' HTTP request header
     # @param path [String] the URI/path to request from the server
     # @param timeout_sec [Int] how many seconds to allow request to run before timing out and setting @timed_out_status to True
+    # @param protocol [String] the protocol to connect to the server (default 'http', can be 'https')
+    # @param bypass_ssl_verify [Boolean] if true, SSL verification will be bypassed (useful for self-signed certificates)
     #
     # @api public
     # @return [Serverspec::Type::Http_Get]
-    def http_get(port, host_header, path, timeout_sec=10)
-      Http_Get.new(port, host_header, path, timeout_sec=timeout_sec)
+    def http_get(port, host_header, path, timeout_sec=10, protocol='http', bypass_ssl_verify=false)
+      Http_Get.new(port, host_header, path, timeout_sec, protocol, bypass_ssl_verify)
     end
   end
 end

data/lib/serverspec_extended_types/version.rb

@@ -1,3 +1,3 @@
 module ServerspecExtendedTypes
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/types/http_get_spec.rb

@@ -4,7 +4,7 @@ require 'serverspec_extended_types/http_get'
 describe 'http_get()' do
   context 'Serverspec::Type method' do
     it 'instantiates the class with the correct parameters' do
-      expect(Serverspec::Type::Http_Get).to receive(:new).with(1, 'hostheader', 'mypath', timeout_sec=20)
+      expect(Serverspec::Type::Http_Get).to receive(:new).with(1, 'hostheader', 'mypath', timeout_sec=20, 'http', false)
       http_get(1, 'hostheader', 'mypath', timeout_sec=20)
     end
     it 'returns the new object' do
@@ -26,6 +26,8 @@ describe 'http_get()' do
       expect(x.instance_variable_get(:@headers_hash)).to be nil
       expect(x.instance_variable_get(:@response_code_int)).to be nil
       expect(x.instance_variable_get(:@response_json)).to be nil
+      expect(x.instance_variable_get(:@protocol)).to eq 'http'
+      expect(x.instance_variable_get(:@bypass_ssl_verify)).to eq false
     end
     it 'calls getpage' do
       expect_any_instance_of(Serverspec::Type::Http_Get).to receive(:getpage).once
@@ -74,6 +76,32 @@ describe 'http_get()' do
       expect(x.json).to be_empty
       expect(x.json).to be_a_kind_of(Hash)
     end
+    it 'supports https' do
+      # boilerplate
+      stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
+      headers = double
+      expect(headers).to receive(:[]=).with(:user_agent, %r"Serverspec::Type::Http_Get/\d+\.\d+\.\d+ \(https://github.com/jantman/serverspec-extended-types\)")
+      expect(headers).to receive(:[]=).with(:Host, 'hostheader')
+      conn = double(headers: headers)
+      response = double(status: 200, body: "OK", headers: [])
+      expect(conn).to receive(:get).with('mypath').and_return(response)
+      # most importantly, we want https here
+      expect(Faraday).to receive(:new).with("https://myhost:1/").and_return(conn)
+      x = http_get(1, 'hostheader', 'mypath', 30, 'https')
+    end
+    it 'supports ssl verify bypass for self-signed certificates' do
+      # boilerplate
+      stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
+      headers = double
+      expect(headers).to receive(:[]=).with(:user_agent, %r"Serverspec::Type::Http_Get/\d+\.\d+\.\d+ \(https://github.com/jantman/serverspec-extended-types\)")
+      expect(headers).to receive(:[]=).with(:Host, 'hostheader')
+      conn = double(headers: headers)
+      response = double(status: 200, body: "OK", headers: [])
+      expect(conn).to receive(:get).with('mypath').and_return(response)
+      # most importantly, we want https here
+      expect(Faraday).to receive(:new).with("https://myhost:1/", {ssl: {verify: false}}).and_return(conn)
+      x = http_get(1, 'hostheader', 'mypath', 30, 'https', true)
+    end
     it 'sets JSON if parsable' do
       stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
       conn = double

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-extended-types
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jason Antman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec
@@ -42,28 +42,28 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -84,84 +84,84 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem provides some purpose-specific types for ServerSpec 2.x beyond
@@ -201,17 +201,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A set of extended types for ServerSpec 2.x