hammer_cli_foreman_webhooks 0.0.1 → 0.0.4

data/test/functional/test_helper.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+require 'hammer_cli/testing/output_matchers'
+require 'hammer_cli/testing/command_assertions'
+require 'hammer_cli/testing/data_helpers'
+require 'hammer_cli_foreman/testing/api_expectations'
+
+include HammerCLI::Testing::OutputMatchers
+include HammerCLI::Testing::CommandAssertions
+include HammerCLI::Testing::DataHelpers
+include HammerCLIForeman::Testing::APIExpectations

data/test/functional/webhook_template_test.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'webhook template' do
+  describe 'import' do
+    let(:template) do
+      {
+        'id' => 1,
+        'template' => 'Template content'
+      }
+    end
+    let(:cmd) { %w(webhook-template import) }
+    let(:tempfile) { Tempfile.new('template') }
+
+    it 'requires --name and --file' do
+      params = ['--name=test']
+      api_expects_no_call
+      expected_result = usage_error_result(
+        cmd,
+        'Options --name, --file are required.',
+        'Could not import the webhook template')
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'import template' do
+      params = ['--name=test', "--file=#{tempfile.path}"]
+      tempfile.write('Template content')
+      tempfile.rewind
+      api_expects(:webhook_templates, :import, 'Import webhook template').with_params(
+        'webhook_template' => {
+          'name' => 'test',
+          'template' => 'Template content'
+        }).returns(template)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(success_result("Imported webhook template successfully.\n"), result)
+    end
+  end
+
+  describe 'export' do
+    let(:cmd) { %w(webhook-template export) }
+    let(:tempfile) { Tempfile.new('template', '/tmp') }
+    let(:params) { ['--id=1', '--path=/tmp'] }
+    let(:template_response) do
+      response = mock('TemplateResponse')
+      response.stubs(:code).returns(200)
+      response.stubs(:body).returns('Template content')
+      response.stubs(:headers).returns({:content_disposition => "filename=\"#{File.basename(tempfile.path)}\""})
+      response
+    end
+
+    it 'download template' do
+      api_expects(:webhook_templates, :export, 'Export webhook template').with_params(
+        'id' => '1').returns(template_response)
+
+      output = OutputMatcher.new("The webhook template has been saved to #{tempfile.path}")
+      expected_result = success_result(output)
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+      assert_equal('Template content', tempfile.read)
+    end
+  end
+end

data/test/functional/webhook_test.rb

@@ -0,0 +1,126 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'webhook' do
+  let(:base_cmd) { %w[webhook] }
+  let(:webhook) do
+    {
+      id: 1,
+      name: 'test',
+      target_url: 'https://app.example.com',
+      enabled: true,
+      event: 'user_created.event.foreman',
+      http_method: 'POST',
+      http_content_type: 'application/json',
+      webhook_template: { id: 1, name: 'test' },
+      user: 'admin',
+      verify_ssl: true,
+      proxy_authorization: true,
+      ssl_ca_certs: 'certs',
+      'http_headers' => '{"X-Shellhook-Arg-0":"test","X-Shellhook-Arg-1":"2"}',
+      created_at: '01/10/2022',
+      updated_at: '01/10/2022'
+    }
+  end
+
+  describe 'list' do
+    let(:cmd) { base_cmd << 'list' }
+
+    it 'should list all webhooks' do
+      api_expects(:webhooks, :index, 'List').with_params(
+        'page' => 1, 'per_page' => 1000
+      ).returns(index_response([webhook]))
+
+      output = IndexMatcher.new(
+        [
+          ['ID', 'NAME',  'TARGET URL',              'ENABLED'],
+          ['1',  'test',  'https://app.example.com', 'yes']
+        ]
+      )
+      expected_result = success_result(output)
+
+      result = run_cmd(cmd)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'create' do
+    let(:cmd) { base_cmd << 'create' }
+    let(:params) do
+      %w[
+        --name=test --target-url=https://app.example.com --enabled=true
+        --event=user_created.event.foreman
+        --http-headers=X-Shellhook-Arg-0=test,X-Shellhook-Arg-1=2
+      ]
+    end
+
+    it 'should create a webhook' do
+      api_expects(:webhooks, :create).with_params(
+        'webhook' => {
+          'target_url' => 'https://app.example.com', 'name' => 'test',
+          'enabled' => true, 'event' => 'user_created.event.foreman',
+          'http_headers' => '{"X-Shellhook-Arg-0":"test","X-Shellhook-Arg-1":"2"}'
+        }
+      ).returns(webhook)
+
+      expected_result = success_result("Webhook [test] created.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'update' do
+    let(:cmd) { base_cmd << 'update' }
+    let(:params) do
+      %w[
+        --id=1 --target-url=https://app.example.com --enabled=true
+        --event=user_created.event.foreman
+        --http-headers=X-Shellhook-Arg-0=test,X-Shellhook-Arg-1=2
+      ]
+    end
+
+    it 'should update a webhook' do
+      api_expects(:webhooks, :update).with_params(
+        'id' => '1',
+        'webhook' => {
+          'target_url' => 'https://app.example.com',
+          'enabled' => true, 'event' => 'user_created.event.foreman',
+          'http_headers' => '{"X-Shellhook-Arg-0":"test","X-Shellhook-Arg-1":"2"}'
+        }
+      ).returns(webhook)
+
+      expected_result = success_result("Webhook [test] updated.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'info' do
+    let(:cmd) { base_cmd << 'info' }
+    let(:params) { %w[--id=1] }
+
+    it 'should show a webhook' do
+      api_expects(:webhooks, :show, 'Show').with_params('id' => '1').returns(webhook)
+
+      expected_result = success_result(/X-Shellhook-Arg-0/)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'delete' do
+    let(:cmd) { base_cmd << 'delete' }
+    let(:params) { %w[--id=1] }
+
+    it 'should delete a webhook' do
+      api_expects(:webhooks, :destroy, 'Delete').with_params('id' => '1').returns(webhook)
+
+      expected_result = success_result("Webhook [test] deleted.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+ENV['TEST_API_VERSION'] = ENV['TEST_API_VERSION'] || '3.3'
+FOREMAN_WEBHOOKS_VERSION = Gem::Version.new(ENV['TEST_API_VERSION']).to_s
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest-spec-context'
+require 'mocha/minitest'
+require 'hammer_cli'
+
+HammerCLI.context[:api_connection].create('foreman') do
+  HammerCLI::Apipie::ApiConnection.new(
+    apidoc_cache_dir: 'test/data/' + FOREMAN_WEBHOOKS_VERSION,
+    apidoc_cache_name: 'foreman_api',
+    dry_run: true
+  )
+end
+
+require 'hammer_cli_foreman_webhooks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli_foreman_webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hammer_cli_foreman
@@ -19,7 +19,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 description: 
 email:
 - ofedoren@redhat.com
@@ -46,6 +46,11 @@ files:
 - lib/hammer_cli_foreman_webhooks/version.rb
 - lib/hammer_cli_foreman_webhooks/webhook.rb
 - lib/hammer_cli_foreman_webhooks/webhook_template.rb
+- test/data/3.3/foreman_api.json
+- test/functional/test_helper.rb
+- test/functional/webhook_template_test.rb
+- test/functional/webhook_test.rb
+- test/test_helper.rb
 homepage: https://github.com/theforeman/hammer-cli-foreman-webhooks
 licenses:
 - GPL-3.0
@@ -65,9 +70,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Foreman Webhooks plugin for Hammer CLI
-test_files: []
+test_files:
+- test/data/3.3/foreman_api.json
+- test/functional/test_helper.rb
+- test/functional/webhook_template_test.rb
+- test/functional/webhook_test.rb
+- test/test_helper.rb