octopus-serverspec-extensions 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfed5ab53aabecaa3e4f1d3456ee6a5d6f319ba1
+  data.tar.gz: 4f742c5038c75db738332bf47a62c773158e3464
+SHA512:
+  metadata.gz: 8de409c5b768a1da9316fc711d13df8d2fb055b3f10a2fc4aa0acbc25c4e540e0e8c7f8da4c1eed95c8e54fed0543bc052fa6245abf51cba96e4e972a96c9191
+  data.tar.gz: 8159ab5d1678a4dd2961214a404e56664016b8b82b842863510a9a45fc18f36928d824c2c026efa962067f9861297b0884b48027f6ad5e6e20c29ea37dab11e7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+octopus-serverspec-extensions-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in octopus-serverspec-extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Octopus Deploy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Octopus::Serverspec::Extensions
+
+SeverSpec extensions for Windows, adding support for chocolatey packages, npm packages, service accounts and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octopus-serverspec-extensions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopus-serverspec-extensions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/octopus-deploy/octopus-serverspec-extensions.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octopus/serverspec/extensions"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/octopus_serverspec_extensions.rb

@@ -0,0 +1,9 @@
+require 'octopus_serverspec_extensions/type/chocolatey_package.rb'
+require 'octopus_serverspec_extensions/type/npm_package.rb'
+require 'octopus_serverspec_extensions/type/java_property_file.rb'
+require 'octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb'
+require 'octopus_serverspec_extensions/matcher/have_version.rb'
+require 'octopus_serverspec_extensions/matcher/run_under_account.rb'
+require 'octopus_serverspec_extensions/matcher/have_windows_line_endings.rb'
+require 'octopus_serverspec_extensions/matcher/have_linux_line_endings.rb'
+require 'octopus_serverspec_extensions/version.rb'

data/lib/octopus_serverspec_extensions/matcher/have_linux_line_endings.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_linux_line_endings do
+  match do |file|
+    !file.content.include?("\r\n")
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/have_version.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :have_version do |version|
+  match do |file|
+    version_dll = Fiddle.dlopen('version.dll')
+
+    s=''
+    vsize = Fiddle::Function.new(version_dll['GetFileVersionInfoSize'],
+                [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VOIDP],
+                Fiddle::TYPE_LONG).call(file.name, s)
+
+    raise 'Unable to determine the version number' unless vsize > 0
+
+    result = ' '*vsize
+    Fiddle::Function.new(version_dll['GetFileVersionInfo'],
+                         [Fiddle::TYPE_VOIDP, Fiddle::TYPE_LONG,
+                          Fiddle::TYPE_LONG, Fiddle::TYPE_VOIDP],
+            Fiddle::TYPE_VOIDP).call(file.name, 0, vsize, result)
+
+    rstring = result.unpack('v*').map{|s| s.chr if s<256}*''
+    r = /FileVersion..(.*?)\000/.match(rstring)
+
+    r[1] == version
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/have_windows_line_endings.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_windows_line_endings do
+  match do |file|
+    file.content.include?("\r\n")
+  end
+end

data/lib/octopus_serverspec_extensions/matcher/run_under_account.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :run_under_account do |account_name|
+  match do |service|
+    Backend::PowerShell::Command.new do
+      exec "(Get-WmiObject win32_service | where-object { $_.Name -eq '#{service.name}' }).StartName -eq '#{account_name}"
+    end
+  end
+end

data/lib/octopus_serverspec_extensions/type/chocolatey_package.rb

@@ -0,0 +1,34 @@
+require 'serverspec'
+require 'serverspec/type/base'
+
+module Serverspec::Type
+  class ChocolateyPackage < Base
+
+    def initialize(name)
+      @name = name
+      @runner = Specinfra::Runner
+    end
+
+    def installed?(provider, version)
+      command_result = @runner.run_command("choco list -l -r #{name}")
+
+      software = command_result.stdout.split("\r\n").each_with_object({}) do |s, h|
+        v, k = s.split('|')
+        h[String(v).strip.downcase] = String(k).strip.downcase
+        h
+      end
+
+      if (version.nil?)
+        !software[name.downcase].nil?
+      else
+        software[name.downcase] == version
+      end
+    end
+  end
+
+  def chocolatey_package(name)
+    ChocolateyPackage.new(name)
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/java_property_file.rb

@@ -0,0 +1,29 @@
+require 'serverspec'
+require 'serverspec/type/base'
+
+module Serverspec::Type
+  class JavaPropertyFile < Base
+
+    def initialize(name)
+      @name = name
+      @runner = Specinfra::Runner
+    end
+
+    def has_property?(propertyName, propertyValue)
+      properties = {}
+      IO.foreach(@name) do |line|
+        if (!line.start_with?('#'))
+          properties[$1.strip] = $2 if line =~ /([^=]*)=(.*)/
+        end
+      end
+
+      properties[propertyName] == propertyValue
+    end
+  end
+
+  def java_property_file(name)
+    JavaPropertyFile.new(name)
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/npm_package.rb

@@ -0,0 +1,37 @@
+require 'serverspec'
+require 'serverspec/type/base'
+
+module Serverspec::Type
+  class NpmPackage < Base
+
+    def initialize(name)
+      @name = name
+      @runner = Specinfra::Runner
+    end
+
+    def installed?(provider, version)
+      command_result = @runner.run_command("npm list -g #{name}")
+
+      software = command_result.stdout.split("\n").each_with_object({}) do |s, h|
+        if s.include? "@"
+          package_name, package_version = s.split('@')
+          package_name = package_name.gsub(/.*? /, '')
+          h[String(package_name).strip.downcase] = String(package_version).strip.downcase
+        end
+        h
+      end
+
+      if (version.nil?)
+        !software[name.downcase].nil?
+      else
+        software[name.downcase] == version
+      end
+    end
+  end
+
+  def npm_package(name)
+    NpmPackage.new(name)
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb

@@ -0,0 +1,122 @@
+require 'serverspec'
+require 'serverspec/type/base'
+require 'net/http'
+require 'json'
+
+module Serverspec::Type
+  class OctopusDeployTentacle < Base
+    @machine = nil
+    @serverUrl = nil
+    @apiKey = nil
+
+    def initialize(serverUrl, apiKey, instance)
+      @name = "Octopus Deploy Tentacle #{instance}"
+      @runner = Specinfra::Runner
+      @serverUrl = serverUrl
+      @apiKey = apiKey
+
+      if (serverUrl.nil?)
+        puts "'serverUrl' was not provided. Unable to connect to Octopus server to validate configuration."
+        return
+      end
+      if (apiKey.nil?)
+        puts "'apiKey' was not provided. Unable to connect to Octopus server to validate configuration."
+        return
+      end
+
+      if (exists?)
+        thumbprint = `"c:\\program files\\Octopus Deploy\\Tentacle\\Tentacle.exe" --console --show-thumbprint --nologo --instance #{instance}`.strip.gsub('The thumbprint of this Tentacle is: ', '')
+        @machine = get_machine_via_api(serverUrl, apiKey, thumbprint)
+      end
+    end
+
+    def registered_with_the_server?
+      !@machine.nil?
+    end
+
+    def online?
+      return nil if @machine.nil?
+      @machine = poll_until_machine_has_completed_healthcheck(@serverUrl, @apiKey, @machine["Thumbprint"])
+      puts "Expected status 'Online|CalamariNeedsUpgrade|NeedsUpgrade' for Tentacle #{@name}, but got '#{@machine["Status"]}'" if (@machine["Status"] != "Online" && @machine["Status"] != "CalamariNeedsUpgrade")
+      @machine["Status"] == "Online" || @machine["Status"] == "CalamariNeedsUpgrade" || @machine["Status"] == "NeedsUpgrade"
+    end
+
+    def in_environment?(environment_name)
+      return false if @machine.nil?
+      url = "#{@serverUrl}/api/environments/all?api-key=#{@apiKey}"
+      resp = Net::HTTP.get_response(URI.parse(url))
+      environments = JSON.parse(resp.body)
+      environment_id = environments.select {|e| e["Name"] == environment_name}.first["Id"]
+      !@machine["EnvironmentIds"].select {|e| e == environment_id}.empty?
+    end
+
+    def has_role?(role_name)
+      return false if @machine.nil?
+      roles = @machine["Roles"]
+      !roles.select {|e| e == role_name}.empty?
+    end
+
+    def listening_tentacle?
+      return false if @machine.nil?
+      puts "Expected CommunicationStyle 'TentaclePassive' for Tentacle #{@name}, but got '#{@machine["EndPoint"]["CommunicationStyle"]}'" if (@machine["EndPoint"]["CommunicationStyle"] != "TentaclePassive")
+      @machine["EndPoint"]["CommunicationStyle"] == "TentaclePassive"
+    end
+
+    def polling_tentacle?
+      return false if @machine.nil?
+      puts "Expected CommunicationStyle 'TentacleActive' for Tentacle #{@name}, but got '#{@machine["EndPoint"]["CommunicationStyle"]}'" if (@machine["EndPoint"]["CommunicationStyle"] != "TentacleActive")
+      @machine["EndPoint"]["CommunicationStyle"] == "TentacleActive"
+    end
+
+    def exists?
+      ::File.exists?("c:\\program files\\Octopus Deploy\\Tentacle\\Tentacle.exe")
+    end
+  end
+
+  def octopus_deploy_tentacle(serverUrl, apiKey, instance)
+    OctopusDeployTentacle.new(serverUrl, apiKey, instance)
+  end
+
+  private
+
+  def poll_until_machine_has_completed_healthcheck(serverUrl, apiKey, thumbprint)
+    machine = nil
+    url = "#{serverUrl}/api/machines/all?api-key=#{apiKey}"
+
+    now = Time.now
+    counter = 1
+    loop do
+      machine = get_machine_via_api(serverUrl, apiKey, thumbprint)
+
+      break if machine.nil?
+      break if counter > 10
+      break if !machine_healthcheck_outstanding(machine)
+      puts "Machine health check for #{machine["Name"]} has not yet completed. Waiting 5 seconds to try again."
+      counter += 1
+      sleep 5
+    end
+
+    machine
+  end
+
+  def machine_healthcheck_outstanding(machine)
+    machine["StatusSummary"] == "This machine was recently added. Please perform a health check."
+  end
+
+  def get_machine_via_api(serverUrl, apiKey, thumbprint)
+    machine = nil
+    url = "#{serverUrl}/api/machines/all?api-key=#{apiKey}"
+
+    begin
+      resp = Net::HTTP.get_response(URI.parse(url))
+      body = JSON.parse(resp.body)
+      machine = body.select {|e| e["Thumbprint"] == thumbprint}.first unless body.nil?
+    rescue => e
+      puts "Unable to connect to #{url}: #{e}"
+    end
+
+    machine
+  end
+end
+
+include Serverspec::Type

data/lib/octopus_serverspec_extensions/version.rb

@@ -0,0 +1,3 @@
+module OctopusServerSpecExtensions
+  VERSION = "0.6.0"
+end

data/octopus-serverspec-extensions.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopus_serverspec_extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "octopus-serverspec-extensions"
+  spec.version       = OctopusServerSpecExtensions::VERSION
+  spec.authors       = ["Matt Richardson"]
+  spec.email         = "devops@octopus.com"
+  spec.summary       = %q{SeverSpec extensions for Windows}
+  spec.description   = %q{SeverSpec extensions for Windows, adding support for chocolatey packages, npm packages, service accounts and more.}
+  spec.homepage      = "https://github.com/octopus-deploy/octopus-serverspec-extensions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "serverspec", "~> 2"
+  spec.add_dependency "specinfra", "~> 2"
+  spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'json', '~> 1.8', '>= 1.8.3'
+  spec.add_dependency 'fiddle', '~> 0.6.3'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-teamcity", "~> 0.0.1"
+
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: octopus-serverspec-extensions
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Matt Richardson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: specinfra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-teamcity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: SeverSpec extensions for Windows, adding support for chocolatey packages,
+  npm packages, service accounts and more.
+email: devops@octopus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/octopus_serverspec_extensions.rb
+- lib/octopus_serverspec_extensions/matcher/have_linux_line_endings.rb
+- lib/octopus_serverspec_extensions/matcher/have_version.rb
+- lib/octopus_serverspec_extensions/matcher/have_windows_line_endings.rb
+- lib/octopus_serverspec_extensions/matcher/run_under_account.rb
+- lib/octopus_serverspec_extensions/type/chocolatey_package.rb
+- lib/octopus_serverspec_extensions/type/java_property_file.rb
+- lib/octopus_serverspec_extensions/type/npm_package.rb
+- lib/octopus_serverspec_extensions/type/octopus_deploy_tentacle.rb
+- lib/octopus_serverspec_extensions/version.rb
+- octopus-serverspec-extensions.gemspec
+homepage: https://github.com/octopus-deploy/octopus-serverspec-extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.7
+signing_key: 
+specification_version: 4
+summary: SeverSpec extensions for Windows
+test_files: []