Use the default theforeman/action for smart proxy plugins.

Author: martencassel

.github/workflows/ci.yml

@@ -1,30 +1,14 @@
 name: CI
 
-on:
-  - pull_request
-  - push
+on: pull_request
+
+concurrency:
+  group: ${{ github.ref_name }}-${{ github.workflow }}
+  cancel-in-progress: true
 
 jobs:
   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"

.gitignore

@@ -7,4 +7,4 @@ Gemfile.lock
 .rvmrc*
 .ruby-*
 tags
-vendor
+vendor

.vscode/launch.json

@@ -58,4 +58,5 @@
             "program": "${workspaceRoot}/bin/cucumber"
         }
     ]
-}
+}
+

README.md

@@ -1,20 +1,20 @@
 # Description
 This plugin adds a new realm provider for managing hosts in Active Directory.
 
-Useful if you directly integrate with Active Directory and dont use FreeIPA. 
+Useful if you directly integrate with Active Directory and dont use FreeIPA.
 
 If you use this plugin you let foreman-proxy provision/deprovision computer accounts and password and also distribute the password to a kickstart file.
 
 It does the following:
 
   * When hosts are created in foreman it will create a new computer account in active directory
     and return the password to foreman so it can be used in the kickstart file.
-    
+
   * When hosts are rebuilt it will reset the computers account and return a new password to the kickstart file.
 
   * When hosts are deleted in foreman it will delete the associated computer account in active directory.
-  
-# Installation 
+
+# Installation
 ```
 sudo gem install smart_proxy_realm_ad_plugin
 ```
@@ -25,9 +25,9 @@ Then enable this as a realm provider in foreman-proxy
 To enable this realm provider, edit `/etc/foreman-proxy/settings.d/realm.yml` and set:
 
     :enabled: true
-    
+
     :use_provider: realm_ad
-    
+
 # Building
 
 See How_to_Install_a_Smart-Proxy_Plugin for how to install Smart Proxy plugins.
@@ -36,7 +36,7 @@ Install this gem:
 
 First clone this repo:
 ```
-git clone https://github.com/martencassel/smart_proxy_realm_ad_plugin 
+git clone https://github.com/martencassel/smart_proxy_realm_ad_plugin
 ```
 
 Then run bundle and gem install.
@@ -109,4 +109,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

smart_proxy_realm_ad_plugin.gemspec

@@ -5,20 +5,22 @@ 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')
+  s.add_development_dependency('rake', '~> 13.2')
+  s.add_development_dependency('mocha', '~> 2.7')
+  s.add_development_dependency('test-unit', '~> 3.6')
+  s.add_dependency('rkerberos', '~> 0.1.5')
+  s.add_dependency('radcli', '~> 1.1')
 end

test/ad_provider_test.rb

@@ -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/setup_ad.md

@@ -33,4 +33,5 @@ marten@martenubuntu:~/src/smart-proxy$
 
 
 apt-get install adcli
-adcli info --domain=EXAMPLE.COM --domain-controller=dc.example.com
+adcli info --domain=EXAMPLE.COM --domain-controller=dc.example.com
+

test/test_helper.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
-require 'mocha/setup'
+require 'mocha/test_unit'
 
 require 'smart_proxy_for_testing'
 
 # create log directory in our (not smart-proxy) directory
-FileUtils.mkdir_p File.dirname(Proxy::SETTINGS.log_file)
+FileUtils.mkdir_p File.dirname(Proxy::SETTINGS.log_file)