Add shared GitHub Actions workflow for ruby (#180)

* Add shared GitHub Actions workflow for ruby

* Update .github/workflows/ruby_ci.yml

* Fix rubocop

* Run CI on push

---------

Co-authored-by: Adam Ruzicka <aruzicka@redhat.com>
Co-authored-by: Ewoud Kohl van Wijngaarden <ewoud@kohlvanwijngaarden.nl>

Author: 3 people

.github/workflows/ruby_ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - '*-stable'
+
+concurrency:
+  group: ${{ github.ref_name }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  rubocop:
+    name: Rubocop
+    uses: theforeman/actions/.github/workflows/rubocop.yml@v0
+    with:
+      command: bundle exec rubocop --parallel --format github
+
+  test:
+    name: Ruby
+    needs: rubocop
+    uses: theforeman/actions/.github/workflows/foreman_plugin.yml@v0
+    with:
+      plugin: foreman_templates

.rubocop_todo.yml

@@ -18,3 +18,9 @@ Gemspec/RequiredRubyVersion:
 # Include: **/Rakefile, **/*.rake
 Rails/RakeEnvironment:
   Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false

app/models/concerns/foreman_templates/template_extensions.rb

@@ -5,7 +5,7 @@ module TemplateExtensions
     extend ActiveSupport::Concern
 
     def template_file
-      Shellwords.escape(name.downcase.tr(' /', '_') + '.erb')
+      Shellwords.escape("#{name.downcase.tr(' /', '_')}.erb")
     end
   end
 end

app/services/foreman_templates/template_exporter.rb

@@ -168,8 +168,10 @@ def find_taxed_templates
     end
 
     def templates_query(tax_ids)
-      Template.where(:id => TaxableTaxonomy.where(:taxonomy_id => tax_ids,
-                                                  :taxable_type => Template.subclasses.map(&:name)).pluck(:taxable_id))
+      Template.where(:id => TaxableTaxonomy.where(
+        :taxonomy_id => tax_ids,
+        :taxable_type => Template.subclasses.map(&:name)
+      ).pluck(:taxable_id))
     end
 
     def taxes_ids(tax_type)

app/services/foreman_templates/template_importer.rb

@@ -47,7 +47,7 @@ def import_from_git
 
     def parse_files!
       Dir["#{@dir}/#{@dirname}/**/*.erb"].each do |template_file|
-        logger.debug 'Parsing: ' + template_file.gsub(%r{#{@dir}\/#{@dirname}}, '')
+        logger.debug "Parsing: #{template_file.gsub(%r{#{@dir}/#{@dirname}}, '')}"
         parse_result = ParseResult.new(template_file)
 
         text = File.read(template_file)

foreman_templates.gemspec

@@ -14,9 +14,10 @@ Gem::Specification.new do |s|
     "LICENSE",
     "README.md"
   ]
-  s.files            = Dir["{app,config,db,lib,webpack}/**/*"] + ["LICENSE", "Rakefile", "README.md", "package.json"] + \
-    # .mo files are compiled; .po are sources; .edit.po are temporary files
-    Dir['locale/*/LC_MESSAGES/*.mo'] + Dir["locale/*/#{s.name}.po"]
+  s.files            = Dir["{app,config,db,lib,webpack}/**/*"] + \
+                       ["LICENSE", "Rakefile", "README.md", "package.json"] + \
+                       # .mo files are compiled; .po are sources; .edit.po are temporary files
+                       Dir['locale/*/LC_MESSAGES/*.mo'] + Dir["locale/*/#{s.name}.po"]
   s.homepage         = 'https://github.com/theforeman/foreman_templates'
   s.licenses         = ["GPL-3.0"]
   s.summary          = 'Template-syncing engine for Foreman'

test/functional/api/v2/template_controller_test.rb

@@ -26,7 +26,7 @@ class TemplateControllerTest < ::ActionController::TestCase
           FactoryBot.create(:provisioning_template, :name => 'export_test_template')
           post :export, params: { "repo" => tmpdir, "filter" => "^export_test_template", "negate" => true, "metadata_export_mode" => "keep" }
           assert_response :success
-          refute Dir.entries("#{tmpdir}/provisioning_templates/provision").include?('export_test_template.erb')
+          refute_includes(Dir.entries("#{tmpdir}/provisioning_templates/provision"), 'export_test_template.erb')
         end
       end
 
@@ -151,7 +151,7 @@ class TemplateControllerTest < ::ActionController::TestCase
           FactoryBot.create(:provisioning_template, :name => 'exporting_template', :template_kind => kind)
           post :export, params: { "repo" => tmpdir, "filter" => "exporting_template", "metadata_export_mode" => "refresh" }
           assert_response :success
-          assert Dir.entries("#{tmpdir}/provisioning_templates/provision").include?('exporting_template.erb')
+          assert_includes(Dir.entries("#{tmpdir}/provisioning_templates/provision"), 'exporting_template.erb')
         end
       end
 

test/unit/template_exporter_test.rb

@@ -43,25 +43,25 @@ class TemplateExporterTest < ActiveSupport::TestCase
         exporter = TemplateExporter.new(:filter => "", :organization_params => { :organization_ids => [@org.id] })
         templates = exporter.templates_to_dump
         assert_equal 2, templates.count
-        assert templates.include?(@ptable)
-        assert templates.include?(@provisioning_template)
+        assert_includes(templates, @ptable)
+        assert_includes(templates, @provisioning_template)
       end
 
       test 'should export templates only from specified org by name' do
         exporter = TemplateExporter.new(:filter => "", :organization_params => { :organization_names => [@org.name] })
         templates = exporter.templates_to_dump
         assert_equal 2, templates.count
-        assert templates.include?(@ptable)
-        assert templates.include?(@provisioning_template)
+        assert_includes(templates, @ptable)
+        assert_includes(templates, @provisioning_template)
       end
 
       test 'should export template only in both organization and location' do
-        loc =  FactoryBot.create(:location, :name => 'TemplateLoc')
+        loc = FactoryBot.create(:location, :name => 'TemplateLoc')
         template = FactoryBot.create(:provisioning_template, :name => 'exported_template_with_taxonomies', :organizations => [@org], :locations => [loc])
         exporter = TemplateExporter.new(:filter => "", :organization_params => { :organization_ids => [@org.id] }, :location_params => { :location_ids => [loc.id] })
         templates = exporter.templates_to_dump
         assert_equal 1, templates.count
-        assert templates.include?(template)
+        assert_includes(templates, template)
       end
     end
 
@@ -80,8 +80,8 @@ class TemplateExporterTest < ActiveSupport::TestCase
         exporter = TemplateExporter.new(:filter => "", :organization_id => @org.id)
         templates = exporter.templates_to_dump
         assert_equal 2, templates.count
-        assert templates.include?(@ptable)
-        assert templates.include?(@provisioning_template)
+        assert_includes(templates, @ptable)
+        assert_includes(templates, @provisioning_template)
       end
     end