foreman_x509 0.0.1

data/config/routes.rb

@@ -0,0 +1,68 @@
+ForemanX509::Engine.routes.draw do
+  namespace :api do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
+
+      resources :issuers, only: [:index, :create, :show, :update, :destroy] do
+        member do
+          get :bundle
+        end
+      end
+
+      resources :requests, only: [:index, :show]
+
+      resources :certificates, only: [], param: :owner_id do
+        member do
+          resources :generations, only: [:index, :create, :update, :destroy] do
+            member do
+              get :certificate
+              get :key
+            end
+          end
+        end
+      end
+
+      resources :certificates, only: [:index, :create, :show, :update, :destroy] do
+        member do
+          get :chain
+          get :certificate
+          get :key
+        end
+      end
+    end
+  end
+
+  constraints(id: /[^\/]+/) do
+    resources :issuers, only: [:index, :new, :create, :show, :destroy ] do
+      member do
+        get :bundle
+      end
+    end
+
+    resources :requests, only: [:show]
+
+    constraints(owner_id: /[^\/]+/) do
+      resources :certificates, only: [], param: :owner_id do
+        member do
+          resources :generations, only: [:new, :create, :update, :destroy] do
+            member do
+              get  :certificate
+              get  :key
+            end
+          end
+        end
+      end
+    end
+    
+    resources :certificates do
+      member do
+        get :chain
+        get :certificate
+        get :key
+      end
+    end
+  end
+end
+
+Foreman::Application.routes.draw do
+  mount ForemanX509::Engine, at: '/foreman_x509'
+end

data/db/migrate/20250201155706_initialize_foreman_x509_schema.rb

@@ -0,0 +1,37 @@
+class InitializeForemanX509Schema < ActiveRecord::Migration[6.0]
+  def change
+    create_table :foreman_x509_certificates do |t|
+      t.string :name, null: false
+      t.string :description
+      t.bigint :issuer_id
+      t.text   :configuration
+
+      t.timestamps
+    end
+
+    add_index :foreman_x509_certificates, :name, unique: true, name: :foreman_x509_certificates_by_name
+
+    create_table :foreman_x509_generations do |t|
+      t.bigint  :owner_id, null: false
+      t.boolean :active, null: false, default: false
+      t.text    :certificate
+      t.text    :request
+      t.text    :key
+
+      t.timestamps
+    end
+
+    create_table :foreman_x509_issuers do |t|
+      t.bigint :certificate_id, null: false
+      t.string :serial
+      t.bigint :crl_number
+      t.text   :certificate_revocation_list
+
+      t.timestamps
+    end
+
+    add_foreign_key :foreman_x509_certificates, :foreman_x509_issuers, column: :issuer_id, name: :foreman_x509_issuer_for_certificate, on_delete: :nullify
+    add_foreign_key :foreman_x509_generations, :foreman_x509_certificates, column: :owner_id, name: :foreman_x509_owner_for_generation, on_delete: :cascade
+    add_foreign_key :foreman_x509_issuers, :foreman_x509_certificates, column: :certificate_id, name: :foreman_x509_certificate_for_issuer
+  end
+end

data/db/migrate/20250401083842_create_foreman_x509_requests.rb

@@ -0,0 +1,14 @@
+class CreateForemanX509Requests < ActiveRecord::Migration[6.0]
+  def change
+    create_table :foreman_x509_requests do |t|
+      t.bigint :certificate_id, null: false
+      t.bigint :generation_id, null: false
+      t.text :request
+    end
+
+    add_foreign_key :foreman_x509_requests, :foreman_x509_certificates, column: :certificate_id, name: :foreman_x509_request_for_certificate, on_delete: :cascade
+    add_foreign_key :foreman_x509_requests, :foreman_x509_generations, column: :generation_id, name: :foreman_x509_request_for_generation, on_delete: :cascade
+
+    remove_column :foreman_x509_generations, :request, :text
+  end
+end

data/lib/foreman_x509/engine.rb

@@ -0,0 +1,47 @@
+module ForemanX509
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanX509
+    engine_name 'foreman_x509'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    # Add any db migrations
+    initializer 'foreman_x509.load_app_instance_data' do |app|
+      ForemanX509::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_x509.register_mime_tyeps' do |app|
+      Mime::Type.register_alias "application/x-pem-file", :pem
+      Mime::Type.register_alias "application/x-x509-ca-cert", :der
+    end
+
+    initializer 'foreman_x509.register_plugin', :before => :finisher_hook do |app|
+      require 'foreman_x509/plugin'
+    end
+
+    # Include concerns in this config.to_prepare block
+    # config.to_prepare do
+    #   Host::Managed.include ForemanX509::HostExtensions
+    #   HostsHelper.include ForemanX509::HostsHelperExtensions
+    # rescue StandardError => e
+    #   Rails.logger.warn "ForemanX509: skipping engine hook (#{e})"
+    # end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanX509::Engine.load_seed
+      end
+    end
+  end
+
+  def self.table_name_prefix
+    'foreman_x509_'
+  end
+
+
+  def self.use_relative_model_naming
+    true
+  end
+end

data/lib/foreman_x509/plugin.rb

@@ -0,0 +1,30 @@
+Foreman::Plugin.register :foreman_x509 do
+  requires_foreman '>= 3.1.1'
+
+  # Add Global files for extending foreman-core components and routes
+  # register_global_js_file 'global'
+
+  # Add permissions
+  security_block :foreman_x509 do
+  #  permission :view_foreman_x509_certificates, { :certificates => [:index, :show, :certificate, :key] }
+  #  permission :create_foreman_x509_certificates, { :certificates => [:new, :create] }
+  #  permission :destroy_foreman_x509_certificates, { :certificates => [:destroy] }
+  end
+
+  # Add a new role called 'Discovery' if it doesn't exist
+  #role 'ForemanX509', [:view_foreman_x509]
+
+  # add menu entries
+  divider :top_menu, caption: N_('Certificates'), parent: :infrastructure_menu
+  menu :top_menu, :issuers,
+    caption: N_('Issuers'),
+    engine: ForemanX509::Engine,
+    parent: :infrastructure_menu
+  menu :top_menu, :certificates,
+    caption: N_('Certificates'),
+    engine: ForemanX509::Engine,
+    parent: :infrastructure_menu
+
+  # add dashboard widget
+  # widget 'foreman_x509_widget', name: N_('Foreman plugin template widget'), sizex: 4, sizey: 1
+end

data/lib/foreman_x509/version.rb

@@ -0,0 +1,3 @@
+module ForemanX509
+  VERSION = '0.0.1'.freeze
+end

data/lib/foreman_x509.rb

@@ -0,0 +1,4 @@
+require 'foreman_x509/engine'
+
+module ForemanX509
+end

data/lib/tasks/foreman_x509_tasks.rake

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_x509 do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanX509'
+  Rake::TestTask.new(:foreman_x509) do |t|
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_x509']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_x509', 'foreman_x509:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,73 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).name')
+VERSION = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+JSFILES = $(shell find ../app/assets/javascripts/*/locale -name '$(DOMAIN).js')
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po: %.po.time_stamp
+	touch $@
+
+# gettext will trash the .edit.po file if the time stamp doesn't exist or is older than the po file
+%.po.time_stamp: %.po
+	touch --reference $< $@
+
+# Prevent make from treating this as an intermediate file to be cleaned up
+.PRECIOUS: %.po.time_stamp
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	# Initialize new languages
+	cd .. && tx pull -f --all --minimum-perc 50
+	# Force update all existing languages
+	cd .. && tx pull -f --minimum-perc 0
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation
+	@echo then run rake plugin:po_to_json[$(DOMAIN)] from the Foreman installation
+	@echo then run make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) $(JSFILES) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_x509.po

@@ -0,0 +1,19 @@
+# foreman_x509
+#
+# This file is distributed under the same license as foreman_x509.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_x509.pot

@@ -0,0 +1,19 @@
+# foreman_x509
+#
+# This file is distributed under the same license as foreman_x509.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_x509.gemspec
+_('TODO: Description of ForemanX509.')

data/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "foreman_x509",
+  "version": "1.0.0",
+  "description": "DESCRIPTION",
+  "main": "index.js",
+  "scripts": {
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --config jest.config.js",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "create-react-component": "yo react-domain"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_x509.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_x509/issues"
+  },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 6.0.0"
+  },
+  "dependencies": {
+    "react-intl": "^2.8.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.7.0",
+    "@sheerun/mutationobserver-shim": "^0.3.3",
+    "@theforeman/builder": "^6.0.0",
+    "@theforeman/eslint-plugin-foreman": "6.0.0",
+    "@theforeman/find-foreman": "^4.8.0",
+    "@theforeman/test": "^8.0.0",
+    "@theforeman/vendor-dev": "^6.0.0",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
+    "prettier": "^1.19.1",
+    "stylelint-config-standard": "^18.0.0",
+    "stylelint": "^9.3.0"
+  }
+}

data/test/factories/foreman_x509_factories.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :host do
+    name 'foreman_x509'
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,6 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload

data/test/unit/foreman_x509_test.rb

@@ -0,0 +1,11 @@
+require 'test_plugin_helper'
+
+class ForemanX509Test < ActiveSupport::TestCase
+  setup do
+    User.current = User.find_by_login 'admin'
+  end
+
+  test 'the truth' do
+    assert true
+  end
+end

data/webpack/global_index.js

@@ -0,0 +1,17 @@
+import { registerReducer } from 'foremanReact/common/MountingService';
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import Routes from './src/Router/routes'
+import reducers from './src/reducers';
+
+// register reducers
+Object.entries(reducers).forEach(([key, reducer]) =>
+    registerReducer(key, reducer)
+);
+
+// register client routes
+registerRoutes('PluginTemplate', Routes);
+
+// register fills for extending foreman core
+// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
+addGlobalFill('<slotId>', '<fillId>', <div key='plugin-template-example' />, 300);

data/webpack/global_test_setup.js

@@ -0,0 +1,11 @@
+// runs before each test to make sure console.error output will
+// fail a test (i.e. default PropType missing). Check the error
+// output and traceback for actual error.
+global.console.error = (error, stack) => {
+    /* eslint-disable-next-line no-console */
+    if (stack) console.log(stack); // Prints out original stack trace
+    throw new Error(error);
+};
+
+// Increase jest timeout as some tests using multiple http mocks can time out on CI systems.
+jest.setTimeout(10000);

data/webpack/index.js

@@ -0,0 +1,8 @@
+import componentRegistry from 'foremanReact/components/componentRegistry';
+import ExtendedEmptyState from './src/Components/EmptyState/ExtendedEmptyState';
+
+// register components for erb mounting
+componentRegistry.register({
+    name: 'ExtendedEmptyState',
+    type: ExtendedEmptyState,
+});

data/webpack/src/Components/EmptyState/Constants.js

@@ -0,0 +1,2 @@
+export const GENERAL_ACTION_TYPE = '[PLUGIN_TEMPLATE] GENERAL ACTION';
+export const FOREMAN_STORYBOOK = 'https://foreman.surge.sh';

data/webpack/src/Components/EmptyState/EmptyStateReducer.js

@@ -0,0 +1,19 @@
+// This is an example for a generic redux's reducer
+// Reducers should be registered to foreman-core
+// For a further registration demonstration, have a look in `webpack/global_index.js` 
+
+import Immutable from 'seamless-immutable';
+import { GENERAL_ACTION_TYPE } from './Constants';
+
+const initialState = Immutable({});
+
+export default (state = initialState, action) => {
+  const { payload } = action;
+
+  switch (action.type) {
+    case GENERAL_ACTION_TYPE:
+      return state.set('generalProprty', payload);
+    default:
+      return state;
+  }
+};

data/webpack/src/Components/EmptyState/ExtendedEmptyState.js

@@ -0,0 +1,43 @@
+import React from 'react';
+import { Button, Alert } from '@patternfly/react-core';
+import EmptyState from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
+import SkeletonLoader from 'foremanReact/components/common/SkeletonLoader';
+import PropTypes from 'prop-types';
+
+import { STATUS } from 'foremanReact/constants'
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks'
+import { translate as __ } from 'foremanReact/common/I18n';
+import { FOREMAN_STORYBOOK } from './Constants';
+
+const ExtendedEmptyState = ({ header }) => {
+  // AJAX request using useAPI hook
+  const { response: { description }, status } = useAPI('get', '/foreman_x509/plugin_template_description')
+  
+
+  const storybookBtn = (
+    <Button onClick={() => window.open(FOREMAN_STORYBOOK, '_blank')}>
+      Storybook
+    </Button>
+  );
+
+  switch (status) {
+    case STATUS.ERROR:
+      return (<Alert variant="danger" title={__("Loading description has failed")} />);
+    case STATUS.RESOLVED: return (
+      <EmptyState
+        icon="add-circle-o"
+        action={storybookBtn}
+        header={header}
+        description={description}
+        documentation={false}
+      />
+    )
+    default:
+      return (<SkeletonLoader isLoading={status === STATUS.PENDING} count={5} />);
+  }
+};
+ExtendedEmptyState.PropTypes = {
+  header: PropTypes.string.isRequired
+};
+
+export default ExtendedEmptyState;

data/webpack/src/Components/EmptyState/__tests__/ExtendedEmptyState.test.js

@@ -0,0 +1,37 @@
+// Tests work with react-testing-library or enzyme
+// This test uses react testing library
+// https://testing-library.com/docs/react-testing-library/api
+
+// For more information, test utils, and snapshots testing examples:
+// https://github.com/theforeman/foreman-js/tree/master/packages/test
+
+
+import React from 'react';
+import { createStore, applyMiddleware, combineReducers } from 'redux';
+import { render, waitFor, screen } from '@testing-library/react'
+import { Provider } from 'react-redux';
+
+import { reducers as APIReducer } from 'foremanReact/redux/API';
+import { middlewares } from 'foremanReact/redux/middlewares';
+import APIHelper from 'foremanReact/redux/API/API';
+import ExtendedEmptyState from '../ExtendedEmptyState';
+
+jest.mock('foremanReact/redux/API/API');
+
+const reducers = combineReducers(APIReducer);
+const store = createStore(reducers, applyMiddleware(...middlewares));
+const wrapper = ({ children }) => (
+  <Provider store={store}>{children}</Provider>
+);
+describe('foreman plugin template', () => {
+  it('should render an error alert', async () => {
+    APIHelper.get.mockRejectedValue({ error: new Error() });
+    render(<ExtendedEmptyState />, { wrapper });
+    await waitFor(() => expect(screen.getByText('Loading description has failed')).toBeInTheDocument());
+  });
+  it('should render an empty state with custom description', async () => {
+    APIHelper.get.mockResolvedValue({ data: { description: 'some description' } });
+    render(<ExtendedEmptyState />, { wrapper });
+    await waitFor(() => expect(screen.getByText('some description')).toBeInTheDocument());
+  });
+});

data/webpack/src/Extends/index.js

@@ -0,0 +1,15 @@
+// This is an example of extending foreman-core's component via slot&fill
+// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
+/*
+import React from 'react';
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+
+addGlobalFill('slotId', 'fillId', <SomeComponent key="some-key" />, 300);
+
+addGlobalFill(
+  'slotId',
+  'fillId',
+  { someProp: 'this is an override prop' },
+  300
+);
+*/

data/webpack/src/Router/WelcomePage/Welcome.js

@@ -0,0 +1,9 @@
+import React from 'react';
+import ExtendedEmptyState from '../../Components/EmptyState/ExtendedEmptyState';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+const WelcomePage = () => (
+  <ExtendedEmptyState header={__("Welcome to the plugin template")} />
+);
+
+export default WelcomePage;

data/webpack/src/Router/WelcomePage/index.js

@@ -0,0 +1 @@
+export { default } from './Welcome';

data/webpack/src/Router/routes.js

@@ -0,0 +1,12 @@
+import React from 'react';
+import WelcomePage from './WelcomePage';
+
+const routes = [
+  {
+    path: '/foreman_x509/welcome',
+    exact: true,
+    render: (props) => <WelcomePage {...props} />,
+  },
+];
+
+export default routes;

data/webpack/src/reducers.js

@@ -0,0 +1,10 @@
+import { combineReducers } from 'redux';
+import EmptyStateReducer from './Components/EmptyState/EmptyStateReducer';
+
+const reducers = {
+  foremanX509: combineReducers({
+    emptyState: EmptyStateReducer,
+  }),
+};
+
+export default reducers;

data/webpack/test_setup.js

@@ -0,0 +1,17 @@
+import 'core-js/shim';
+import 'regenerator-runtime/runtime';
+import MutationObserver from '@sheerun/mutationobserver-shim';
+
+import { configure } from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+
+configure({ adapter: new Adapter() });
+
+// Mocking translation function
+global.__ = text => text; // eslint-disable-line
+
+// Mocking locales to prevent unnecessary fallback messages
+window.locales = { en: { domain: 'app', locale_data: { app: { '': {} } } } };
+
+// see https://github.com/testing-library/dom-testing-library/releases/tag/v7.0.0
+window.MutationObserver = MutationObserver;