serverspec-extra-types 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16114f68b564482a2f0b4750487c3e33dc039004f97d07ef5c72777ea8214b8e
-  data.tar.gz: a8e65a89904623a18dcc544db127cae571affe9711dc0f078260028c31b9ea74
+  metadata.gz: 07e0b377e97ee5774ad9b82d7d8361ee97710baaf6832aa989e413b878abec88
+  data.tar.gz: 67f044bf10e1d6963e222617ec85710f33ed2b1fa39deda8c05993e609021bcd
 SHA512:
-  metadata.gz: b1cdca60ba8b2d0a6490c5e01620561dd125ca4addd6a77d110491004e65bea53504c5e937fb1edd69d4b4223f24da60edb709310e86f4a89f72ede330eaca15
-  data.tar.gz: 529d8ad17b81bf97d75a61912e3bd7ec48dfcf6474c6528f290fec02db185b1cc9d94344fb6ab33125885f8bb090a4def5f455d613fa282a06821f7af165f940
+  metadata.gz: 4c724cf04b0656794930841f27fe0dd4e878287a14e7df46cb8d29c2b373eb7f28e6736a36dae2596031abfe43c3861a8451791ea32bd480990c7dcc3c1b3406
+  data.tar.gz: ae1e4e5d0f76c6707d71a83f16976941faa721ed1a9185cff96eedf3ddccf94bb002c037ab69a76aaf59f9f5ed1df27839c5b76ffeed80bc0a3ac42ef4771857

data/.gitlab-ci.yml

@@ -0,0 +1,117 @@
+variables:
+  DOCKER_HOST: tcp://docker:2375
+  DOCKER_DRIVER: overlay2
+services:
+  - name: docker:stable-dind
+    alias: localhost
+
+before_script:
+  - >
+    apk --update add --virtual build-dependencies build-base ruby ruby-rdoc ruby-dev ruby-irb postgresql-dev ruby-etc
+    libc-dev zlib-dev linux-headers git ruby-bigdecimal ruby-io-console libstdc++ tzdata postgresql-client
+    nodejs libffi-dev curl wget py-pip ruby-webrick ruby-etc
+  - gem install bundle
+  - bundle install
+
+docker_sevice: &container_config
+  image: docker:stable
+  variables: &task_variables
+    DOCKER_DRIVER: overlay2
+    SERVERSPEC_TARGET: service
+    RAKE_TARGET: serverspec:${SERVERSPEC_TARGET}
+  script:
+    - bundle exec rake ${RAKE_TARGET}
+
+docker_container:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: container
+
+docker_network:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: network
+
+docker_secret:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: secret
+
+docker_config:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: config
+
+docker_node:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: node
+
+curl:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: curl
+
+consul:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: consul
+
+rabbitmq:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: rabbitmq
+
+nfs_export:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: nfs_export
+
+sudo:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: sudo
+
+sudo_user:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: sudo_user
+
+jenkins_plugin:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: jenkins_plugin
+  services:
+    - name: docker:stable-dind
+      alias: localhost
+
+jenkins_credential:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: jenkins_credential
+  services:
+    - name: docker:stable-dind
+      alias: localhost
+
+
+jenkins_jobs:
+  <<: *container_config
+  variables:
+    <<: *task_variables
+    SERVERSPEC_TARGET: jenkins_job
+  services:
+    - name: docker:stable-dind
+      alias: localhost

data/.rubocop.yml

@@ -1,14 +1,20 @@
+inherit_from: .rubocop_todo.yml
+
+#inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.4
   Exclude:
     - 'serverspec-extra-types.gemspec'
     - 'util/mkcode.rb'
+    - 'bin/*'
+    - 'spec/helpers/hash_helper.rb'
 
 Style/Documentation:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 140
+  Max: 160
 
 
 Metrics/MethodLength:
@@ -18,4 +24,20 @@ Metrics/BlockLength:
   Exclude:
     - 'Rakefile'
     - '**/*.rake'
-    - 'spec/**/*.rb'
+    - 'spec/**/*.rb'
+
+Naming/PredicateName:
+  Exclude:
+    - 'lib/**/types/*.rb'
+
+#Naming/AccessorMethodName:
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/**/types/*.rb'
+    - 'spec/sudo_user_spec.rb'
+
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/serverspec_extra_types/types/curl.rb'
+

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start  do
+  add_filter "/spec/"
+  add_filter "/lib/serverspec_extra_types/version.rb"
+end
+
+
+

data/README.md

@@ -43,7 +43,7 @@ require 'serverspec-extra-types'
 [rabbitmq_node_list](#rabbitmq_node_list) | [rabbitmq_user_permission](#rabbitmq_user_permission) | 
 [rabbitmq_vhost_list](#rabbitmq_vhost_list) | [rabbitmq_vhost_policy](#rabbitmq_vhost_policy) | [sudo_user](#sudo_user)
 
-### curl <a name="curl" ></a>
+### curl(url, options = {}) <a name="curl" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
 
 The curl resource allow for check against remote url. Addition parameters are avaliable to allow for insecure certifactes and follow redirects
@@ -579,7 +579,6 @@ Check if secret has a specific label
   end
 ```
 
-
 ### docker_service
 ##### exist
 Check if a service exists by name
@@ -728,46 +727,376 @@ end
 ```
 
 
-### jenkins_credential <a name="jenkins_credential" ></a>
+### jenkins_credential(credential_id) <a name="jenkins_credential" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
+#### exists
+Verifies that the credential exists
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should exist }
+end
+```
+#### have_description(description)
+Checks if the credential description matches the specified text
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should have_description 'Username and Password Credential' }
+end
+```
+#### have_display_name(text)
+Checks if the display name matches the specified text
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should have_display_name 'test/****** (Username and Password Credential)'}
+end
+```
+#### be_username_with_password
+Checks if credential is a username and password
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should be_username_with_password }
+end
+```
+
+#### be_secret_text
+Checks if credential is a secret string
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should be_secret_text }
+end
+```
+#### be_ssh_private_key
+Checks if credential is an ssh private key
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should be_ssh_private_key }
+end
+```
+
+#### be_aws_credential
+Checks if credential is an aws access key/ secret tken pair 
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should be_aws_credential }
+end
+```
+
+#### be_gitlab_api_token
+Checks if credential is a gitlab api token
+```ruby
+describe jenkins_credential('someCredential') do
+  it { should be_gitlab_api_token }
+end
+```
+
 
-_TODO_
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
-### jenkins_job <a name="jenkins_job" ></a>
+### jenkins_job(jobname) <a name="jenkins_job" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
 
-_TODO_
+#### exists
+Verifies that the job exists
+```ruby
+describe jenkins_job('someJob') do
+  it { should exist }
+end
+```
+
+#### have_name(name)
+Verifies that the job has the specified name
+```ruby
+describe jenkins_job('someJob') do
+  it { should have_name 'someJob' }
+end
+```
+
+#### have_display_name(displayName)
+Verifies that the job has the specified display name
+```ruby
+describe jenkins_job('someJob') do
+  it { should have_display_name 'Some Job' }
+end
+```
+
+#### have_full_display_name(displayName)
+Verifies that the job has the specified full display name
+```ruby
+describe jenkins_job('someJob') do
+  it { should have_full_display_name 'someJob' }
+end
+#Jobs in folders use a '»' symbol inbetween the foldername and job name 
+describe jenkins_job('someFolder/someJob') do
+  it { should have_full_display_name 'someFolder » someJob' }
+end
+```
+
+#### have_description(description)
+Verifies that the job has the specified display name
+```ruby
+describe jenkins_job('someJob') do
+  it { should have_description 'Some Job' }
+end
+```
+
+#### be_freestyle / be_freestyle_project
+Verifies that the job is a free style project
+```ruby
+describe jenkins_job('freestyle') do
+  it { should be_freestyle }
+  it { should be_freestyle_project }
+end
+```
+
+#### be_maven / be_maven_project
+Verifies that the job is a maven project
+```ruby
+describe jenkins_job('maven') do
+  it { should be_maven }
+  it { should be_maven_project }
+end
+```
+
+#### be_pipeline / be_pipeline_project
+Verifies that the job is a pipeline project
+```ruby
+describe jenkins_job('pipeleine') do
+  it { should be_pipeline }
+  it { should be_pipeline_project }
+end
+```
+
+#### be_multibranch / be_multibranch_project
+Verifies that the job is a multibranch project
+```ruby
+describe jenkins_job('multibranch') do
+  it { should be_multibranch }
+  it { should be_multibranch_project }
+end
+```
+
+#### be_folder / be_directory
+Verifies that the job is a folder
+```ruby
+describe jenkins_job('folder') do
+  it { should be_multibranch }
+  it { should be_multibranch_project }
+end
+```
+
+#### have_job_type(type) / have_project_type(type)
+Checks if the job has a particular type
+```ruby
+describe jenkins_job('pipeline') do
+  it { should have_job_type('org.jenkinsci.plugins.workflow.job.WorkflowJob') }
+  it { should have_project_type('org.jenkinsci.plugins.workflow.job.WorkflowJob') }
+end
+```
+
+#### have_job(job)
+Checks if the folder conatins the specified job
+```ruby
+describe jenkins_job('folder') do
+  it { should have_job 'job' }
+
+end
+```
+
+#### have_job_count(count)
+Checks if  the folder conatins the specified number of jobs
+```ruby
+describe jenkins_job('folder') do
+  it { should have_job_count 1 }
+end
+```
+
+#### have_empty_job_list
+Checks if the folder conatains no jobs
+```ruby
+describe jenkins_job('folder') do
+  it { should have_empty_job_list }
+end
+```
+
+##### Jobs inside folders
+Jobs inside folder can be acessed vi folderName/jobName (ie the job urls  without any '/jobs') for example
+```ruby
+describe jenkins_job('folder/job') do
+  it { should exist }
+end
+```
+<sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
+
 
 ### jenkins_plugin <a name="jenkins_plugin" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
+#### exists
+Checks if the plugin exists and is installed
+```ruby
+describe jenkins_plugin('ssh-slaves') do
+  it { should exist }
+end
+```
+#### has_version
+Check is plugin has a particular version
+```ruby
+describe jenkins_plugin('ssh-slaves') do
+  it { should have_version '1.29.4' }
+end
+```
+#### be_installed 
+Also supports be_installed from serverspec (by matcher chain not supported)
+```ruby
+describe jenkins_plugin('ssh-slaves') do
+  it { should be_installed }
+  # Supports with_version
+  it { should be_installed.with_version '1.29.4' }
+end
+```
 
-_TODO_
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
-### nfs_export <a name="nfs_export" ></a>
+### nfs_export(export) <a name="nfs_export" ></a>
+#### exist
+Verifies that the specified export exists
+```ruby
+describe nfs_export('/var/nfsroot') do
+  it { should exist }
+  it { should have_host('192.168.1.0/16') }
+  it { should have_host('192.168.1.0/16').with_option('root_squash') }
+  it { should have_host('192.168.1.0/16').with_options('rw,root_squash') }
+  it { should have_host('192.168.1.0/16').with_options(%q[rw root_squash subtree_check]) }
+end
+```
+#### have_host
+Verifies that the specified export has permission for the specified host/cidr range
+
+Supports a with_option matcher to verify if the export has a specifed export option
+Supports a with_options matcher to verify options in list format
+```ruby
+describe nfs_export('/var/nfsroot') do
+  it { should have_host('192.168.1.0/16') }
+  # Check for a specified option
+  it { should have_host('192.168.1.0/16').with_option('root_squash') }
+  # Check for a list of options as a comma delimited string (order is not important)
+  it { should have_host('192.168.1.0/16').with_options('rw,root_squash') }
+  # Check for a list of options as an array
+  it { should have_host('192.168.1.0/16').with_options(%q[rw root_squash subtree_check]) }
+end
+```
 
-_TODO_
 
 ### rabbitmq_node_list <a name="rabbitmq_node_list" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
-
-_TODO_
+#### have_count
+Verifies the number of nodes in the node list
+```ruby
+describe rabbitmq_node_list do
+  it { should have_count(1) }
+end
+```
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
 ### rabbitmq_user_permission <a name="rabbitmq_user_permission" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
+#### read_from_queue(vhost, queue)
+Verifies that the user can read from the specifed queue on the specified vhost
+```ruby
+describe rabbitmq_user_permission('MyUser') do
+  it { should read_from_queue('MyVhost', 'Q1') }
+end
+```
+
+#### write_to_queue(vhost, queue)
+Verifies that the user can read from the specifed queue on the specified vhost
+```ruby
+describe rabbitmq_user_permission('MyUser') do
+  it { should write_to_queue('MyVhost', 'Q1')  }
+end
+```
+
+#### configure_queue(vhost, queue)
+Verifies that the user can configure the specified queue on the specified vhost
+```ruby
+describe rabbitmq_user_permission('MyUser') do
+  it { should configure_queue('MyVhost', 'Q1') }
+end
+```
 
-_TODO_
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
 
 ### rabbitmq_vhost_list <a name="rabbitmq_vhost_list" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
 
-_TODO_
+#### have_vhost(vhost)
+Verifies that the vhost_list contains the specified vhost
+```ruby
+describe rabbitmq_vhost_list do
+  it { should have_vhost('MyVhost') }
+end
+```
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
 
-### rabbitmq_vhost_policy <a name="rabbitmq_node_policy" ></a>
+### rabbitmq_vhost_policy(policy, vhost) <a name="rabbitmq_vhost_policy" ></a>
 <sub><sup>Please note: This type requires curl to be installed on the target host</sup></sub>
+#### exists
+Verifies that the specified policy exists on a given vhost
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should exist }
+end
+```
+
+#### have_ha_mode(mode)
+Verifies the high availability mode
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should have_ha_mode 'exactly' }
+end
+```
+#### have_ha_nodes(count)
+Verifies the number of high availability nodes
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should have_ha_nodes 2 }
+end
+```
+#### have_ha_sync_mode(mode)
+Verifies the high availability syncronisation mode
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should have_ha_sync_mode 'automatic' }
+end
+```
+#### apply_to(type)
+Verifies that the policy is applies to *type*
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should apply_to }
+end
+```
+
+#### mirror_exchanges
+Verifies the policy applies to onlyexchanges
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should mirror_exchanges }
+end
+```
+
+#### mirror_queues
+Verifies the policy applies to both queues and exchanges
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should mirror_queues }
+end
+```
+
+#### mirror_all
+Verifies the policy applies to both queues and exchanges
+```ruby
+describe rabbitmq_vhost_policy('ha-all', 'MyVhost') do
+  it { should mirror_all }
+end
+```
 
-_TODO_
 <sub><sup>Supports the same additional parameters as the curl matcher</sup></sub>
 
 ### sudo_user <a name="sudo_user" ></a>