Add foreman proxy CI action

Author: martencassel

.github/workflows/ci.yml

@@ -1,30 +1,20 @@
 name: CI
 
-on:
-  - pull_request
-  - push
+on: pull_request
+
+concurrency:
+  group: ${{ github.ref_name }}-${{ github.workflow }}
+  cancel-in-progress: true
 
 jobs:
+  rubocop:
+    name: Rubocop
+    uses: theforeman/actions/.github/workflows/rubocop.yml@v0
+      
   test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - "2.5"
-          - "2.6"
-          - "2.7"
-    name: Ruby ${{ matrix.ruby }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install development headers
-        run: sudo apt install libkrb5-dev libldap-dev libsasl2-dev -y
-      - name: Install Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run tests
-        run: bundle exec rake test
-      - name: Verify gem builds
-        run: gem build *.gemspec
+    name: Tests
+    uses: theforeman/actions/.github/workflows/smart_proxy_plugin.yml@v0
+    with:
+      extra_packages: "libkrb5-dev libldap-dev libsasl2-dev"
+    
+ 

Gemfile

@@ -9,4 +9,5 @@ group :development do
   end
 
   gem 'smart_proxy', :git => 'https://github.com/theforeman/smart-proxy.git', :branch => 'develop'
+  gem 'rubocop', '~> 1.0', require: false
 end

Rakefile

@@ -1,5 +1,6 @@
 require 'rake'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -12,3 +13,9 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = ['lib/**/*.rb', 'test/**/*.rb']
+  t.formatters = ['progress']
+end

smart_proxy_realm_ad_plugin.gemspec

@@ -5,20 +5,24 @@ Gem::Specification.new do |s|
   s.name        = 'smart_proxy_realm_ad_plugin'
   s.version     = Proxy::AdRealm::VERSION
   s.date        = Date.today.to_s
-  s.license     = 'GPL-3.0'
+  s.license     = 'GPL-3.0-only'
   s.authors     = ['Mårten Cassel']
   s.email       = ['marten.cassel@gmail.com']
   s.homepage    = 'https://github.com/theforeman/smart_proxy_realm_ad_plugin'
+  s.required_ruby_version = '>= 2.7'
 
   s.summary     = "A realm ad provider plugin for Foreman's smart proxy"
-  s.description = "A realm ad provider plugin for Foreman's smart proxy"
+  s.description = "This plugin provides a realm ad provider for Foreman's smart proxy, allowing integration with Active Directory realms."
+
 
   s.files       = Dir['{config,lib,bundler.d}/**/*'] + ['README.md', 'LICENSE']
   s.test_files  = Dir['test/**/*']
 
-  s.add_development_dependency('rake')
-  s.add_development_dependency('mocha')
-  s.add_development_dependency('test-unit')
-  s.add_dependency('rkerberos')
-  s.add_dependency('radcli')
-end
+  s.add_development_dependency('rake', '~> 13.2')
+  s.add_development_dependency('mocha', '~> 2.7')
+  s.add_development_dependency('minitest', '~> 5.25.4')	
+  s.add_development_dependency('minitest-reporters', '~> 1.7.1')
+  s.add_development_dependency('test-unit', '~> 3.6')
+  s.add_dependency('rkerberos', '~> 0.1')
+  s.add_dependency('radcli', '~> 1.1')
+end

test/ad_provider_test.rb

@@ -3,7 +3,7 @@
 require 'smart_proxy_realm_ad/provider'
 require 'radcli'
 
-class RealmAdTest < Test::Unit::TestCase
+class RealmAdTest < Minitest::Test
   def setup
     @realm = 'test_realm'
     @provider = Proxy::AdRealm::Provider.new(
@@ -72,7 +72,7 @@ def test_rebuild_host_returns_password
   end
 
   def test_generate_password_returns_random_passwords
-    assert_not_equal @provider.generate_password, @provider.generate_password
+    refute_equal @provider.generate_password, @provider.generate_password
   end
 
   def test_generate_password_returns_20_char_long_password
@@ -81,22 +81,22 @@ def test_generate_password_returns_20_char_long_password
 
   def test_apply_computername_prefix_should_return_false_when_prefix_is_nil
     provider = Proxy::AdRealm::Provider.new(computername_prefix: nil, realm: 'example.com')
-    assert_false provider.apply_computername_prefix?('host.example.com')
+    refute provider.apply_computername_prefix?('host.example.com')
   end
 
   def test_apply_computername_prefix_should_return_false_when_prefix_is_empty
     provider = Proxy::AdRealm::Provider.new(computername_prefix: '', realm: 'example.com')
-    assert_false provider.apply_computername_prefix?('host.example.com')
+    refute provider.apply_computername_prefix?('host.example.com')
   end
 
   def test_apply_computername_prefix_should_return_false_when_hostname_contains_prefix
     provider = Proxy::AdRealm::Provider.new(computername_prefix: 'PREFIX-', realm: 'example.com')
-    assert_false provider.apply_computername_prefix?('prefix-host.example.com')
+    refute provider.apply_computername_prefix?('prefix-host.example.com')
   end
 
   def test_apply_computername_prefix_should_return_true_when_computername_hash_is_used
     provider = Proxy::AdRealm::Provider.new(computername_prefix: 'PREFIX-', computername_hash: true, realm: 'example.com')
-    assert_true provider.apply_computername_prefix?('host.example.com')
+    assert provider.apply_computername_prefix?('host.example.com')
   end
 
   def test_hostfqdn_to_computername_uses_prefix
@@ -119,7 +119,7 @@ def test_unrecognized_realm_raises_exception
   end
 
   def test_find
-    assert_true @provider.find('a_host_fqdn')
+    assert @provider.find('a_host_fqdn')
   end
 
   def test_delete

test/internal_api_test.rb

@@ -15,7 +15,7 @@ def container_instance; end
 
 require 'realm/realm_api'
 
-class InternalApiTest < Test::Unit::TestCase
+class InternalApiTest < Minitest::Test
   include Rack::Test::Methods
 
   def app

test/test_helper.rb

@@ -1,5 +1,9 @@
 require 'test/unit'
-require 'mocha/setup'
+require 'minitest/autorun'
+require 'mocha/minitest'
+require 'minitest/reporters'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 require 'smart_proxy_for_testing'