RubyGems - serverspec-extended-types - Versions diffs - 0.1.0 → 0.1.1 - Mend

serverspec-extended-types 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +4 -4
data/CHANGES.md +4 -0
data/README.md +23 -3
data/lib/serverspec_extended_types/http_get.rb +33 -1
data/lib/serverspec_extended_types/version.rb +1 -1
data/spec/types/bitlbee_spec.rb +3 -3
data/spec/types/http_get_spec.rb +52 -0
metadata +2 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7323a24b2db29288fb1c5b48d10444b3febf582d
-  data.tar.gz: 8c6cc0312da2d38b244a933cba6b930c6f67d779
+  metadata.gz: 43a6ac8ec254f443ee6fff4fe712a2144c673e4b
+  data.tar.gz: 01ee9a58e00b00064cd3d5565f6aca55f276b4f0
 SHA512:
-  metadata.gz: de53147b38a00edfd945ed14569e0713fc2045b11ab798cfb1a0431e9fafa4df904f0fcce1256204ed64fcd3d23340ff9d3fe5e3772c9d3347b02bf9fcb4f57d
-  data.tar.gz: 64026f353890298a85bb60b59e0fb2dfe288e042166936002c4fe7938862a72f1f454130398dc19c2c9eeb7f6c64233376b2eba7e90e0d04aafd6af519daea58
+  metadata.gz: 5d647e721a7d0502c79c2ab79108660241d992dbddb5a1c7ce4fc401f075e66bc02f004ab15314181f45f715a0f48c7df14cbeb8527a01f2eeea3c9b125ca041
+  data.tar.gz: 3595abbf99f225406d923b144cec2470a4ee891d184b39050d979fd27e08ea34b9fe021bd6a6ab8f26e8e02c884e6f3ac167b7356b4c783bc067b2cf44da4cf4

data/CHANGES.md CHANGED

@@ -1,5 +1,9 @@
 # serverspec-extended-types, changelog
+## 0.1.1 2017-07-28 ojizero <z.acnts.816@protonmail.ch>
+* Add `redirected_to` and `redirected` matchers for http_get type.
 ## 0.1.0 2017-05-15 Jason Antman <jason@jasonantman.com>
 * Add `protocol` (http|https) and `bypass_ssl_verify` parameters for http_get.

data/README.md CHANGED

@@ -6,7 +6,7 @@
 [![Gem Version](https://img.shields.io/gem/v/serverspec-extended-types.svg)](https://rubygems.org/gems/serverspec-extended-types)
 [![Total Downloads](https://img.shields.io/gem/dt/serverspec-extended-types.svg)](https://rubygems.org/gems/serverspec-extended-types)
 [![Github Issues](https://img.shields.io/github/issues/jantman/serverspec-extended-types.svg)](https://github.com/jantman/serverspec-extended-types/issues)
-[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active)
+[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](http://www.repostatus.org/badges/2.0.0/inactive.svg)](http://www.repostatus.org/#inactive)
 serverspec-extended-types provides some purpose-specific types to be used with [serverspec](http://serverspec.org/) 2.x for
 testing various things on a host, as well as some types for high-level integration tests that make actual requests against
@@ -134,7 +134,7 @@ Returns the String body content of the HTTP response.
     describe http_get(80, 'myhostname', '/') do
       its(:body) { should match /<html>/ }
-	end
+    end
 ##### headers
@@ -167,7 +167,27 @@ True if the request timed out, false otherwise.
     describe http_get(80, 'myhostname', '/') do
       it { should_not be_timed_out }
-	end
+    end
+##### redirected?
+True if the request was redirected, false otherwise.
+    describe http_get(80, 'myhostname', '/') do
+      it { should be_redirected }
+    end
+##### redirected_to?
+True if the request was redirected to the specified location, false otherwise.
+    describe http_get(80, 'myhostname', '/') do
+      it { should be_redirected_to 'https://myhostname/newpath' }
+    end
+    describe http_get(80, 'myhostname', '/') do
+      it { should be_redirected_to 'http://mynewhost/' }
+    end
 ### virtualenv

data/lib/serverspec_extended_types/http_get.rb CHANGED

@@ -20,6 +20,8 @@ module Serverspec
     # Perform an HTTP GET request against the serverspec target
     # using {http://www.rubydoc.info/gems/faraday/ Faraday}.
     class Http_Get < Base
+      # Http status codes that are tested against for redirect test
+      @@redirect_codes = [301, 302, 307, 308]
       # Initialize a bunch of instance variables, then call {#getpage}
       #
@@ -52,6 +54,8 @@ module Serverspec
         @response_json = nil
         @protocol = protocol
         @bypass_ssl_verify = bypass_ssl_verify
+        @redirects = false
+        @redirect_path = nil
         begin
           Timeout::timeout(timeout_sec) do
             getpage
@@ -84,6 +88,8 @@ module Serverspec
         response.headers.each do |header, val|
           @headers_hash[header] = val
         end
+        @redirects = @@redirect_codes.include? @response_code_int
+        @redirect_path = @redirects ? @headers_hash['location'] : nil
         # try to JSON decode
         begin
           @response_json = JSON.parse(@content_str)
@@ -130,7 +136,7 @@ module Serverspec
       def json
         @response_json
       end
       # Returns the HTTP status code, or 0 if timed out
       #
       # @example
@@ -161,6 +167,32 @@ module Serverspec
         @content_str
       end
+      # Whether or not it redirects to some other page
+      #
+      # @example
+      #   describe http_get(80, 'myhostname', '/') do
+      #     it { should be_redirected_to 'https://myhostname/' }
+      #   end
+      #
+      # @api public
+      # @return [Boolean]
+      def redirected_to? (redirect_path)
+        @redirects and @redirect_path == redirect_path
+      end
+      # Whether or not it redirects to any other page
+      #
+      # @example
+      #   describe http_get(80, 'myhostname', '/') do
+      #     it { should be_redirected }
+      #   end
+      #
+      # @api public
+      # @return [Boolean]
+      def redirected?
+        @redirects
+      end
       private :getpage
     end

data/lib/serverspec_extended_types/version.rb CHANGED

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

data/spec/types/bitlbee_spec.rb CHANGED

@@ -96,9 +96,9 @@ describe 'Serverspec::Type::Bitlbee' do
       expect(sslsock_dbl).to receive(:puts).ordered.with("QUIT :\"outta here\"\n")
       expect(sslsock_dbl).to receive(:close).ordered
       expect(OpenSSL::SSL::SSLSocket).to receive(:new).with(sock_dbl, sslctx_dbl).and_return(sslsock_dbl)
-      #expect_any_instance_of(Serverspec::Type::Bitlbee).to receive(:communicate)
+      # expect_any_instance_of(Serverspec::Type::Bitlbee).to receive(:communicate)
       x = bitlbee(1, 'foo', 'bar')
-      x.stub(:communicate) do
+      allow(x).to receive(:communicate) do
         x.instance_variable_get(:@socket).puts("communicate")
       end
       x.connect_ssl
@@ -114,7 +114,7 @@ describe 'Serverspec::Type::Bitlbee' do
       expect(sock_dbl).to receive(:puts).ordered.with("QUIT :\"outta here\"\n")
       expect(sock_dbl).to receive(:close).ordered
       x = bitlbee(1, 'foo', 'bar')
-      x.stub(:communicate) do
+      allow(x).to receive(:communicate) do
         x.instance_variable_get(:@socket).puts("communicate")
       end
       x.connect

data/spec/types/http_get_spec.rb CHANGED

@@ -28,6 +28,8 @@ describe 'http_get()' do
       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
+      expect(x.instance_variable_get(:@redirects)).to eq false
+      expect(x.instance_variable_get(:@redirect_path)).to be nil
     end
     it 'calls getpage' do
       expect_any_instance_of(Serverspec::Type::Http_Get).to receive(:getpage).once
@@ -125,5 +127,55 @@ describe 'http_get()' do
       expected_json = {"foo" => "bar", "baz" => {"blam" => "blarg"}}
       expect(x.json).to eq expected_json
     end
+    it 'without redirects' do
+      stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
+      headers = double('header')
+      conn = double('conn', headers: headers)
+      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')
+      response = double('resp', status: 200, body: 'OK', headers: ({}))
+      expect(conn).to receive(:get).with('mypath').and_return(response)
+      expect(Faraday).to receive(:new).with('http://myhost:1/').and_return(conn)
+      x = http_get(1, 'hostheader', 'mypath')
+      # test internal parameters
+      expect(x.instance_variable_get(:@redirects)).to eq false
+      expect(x.instance_variable_get(:@redirect_path)).to be nil
+      # test exposed API
+      expect(x).to_not be_redirected
+      expect(x).to_not be_redirected_to 'https://myhost:1/mynewpath'
+    end
+    it 'supports redirects' do
+      stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
+      headers = double('header')
+      conn = double('conn', headers: headers)
+      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')
+      redirect_location = 'https://myhost:1/mynewpath'
+      response = double('resp', status: 301, body: 'OK', headers: {'location' => redirect_location})
+      expect(conn).to receive(:get).with('mypath').and_return(response)
+      expect(Faraday).to receive(:new).with('http://myhost:1/').and_return(conn)
+      x = http_get(1, 'hostheader', 'mypath')
+      # test internal parameters
+      expect(x.instance_variable_get(:@redirects)).to eq true
+      expect(x.instance_variable_get(:@redirect_path)).to_not be nil
+      expect(x.instance_variable_get(:@redirect_path)).to eq redirect_location
+      # test exposed API
+      expect(x).to be_redirected
+      expect(x).to be_redirected_to redirect_location
+    end
   end
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-extended-types
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Antman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec