foreman_hdm 0.1.0

data/Rakefile

@@ -0,0 +1,60 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanHdm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end
+
+begin
+  require 'github_changelog_generator/task'
+rescue LoadError
+  # github_changelog_generator is an optional group
+else
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    version = ForemanHdm::VERSION
+    config.future_release = "v#{version}" if /^\d+\.\d+.\d+$/.match?(version)
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
+    config.user = 'betadots'
+    config.project = 'foreman_hdm'
+  end
+end

data/app/controllers/foreman_hdm/keys_controller.rb

@@ -0,0 +1,23 @@
+module ForemanHdm
+  class KeysController < ::ApplicationController
+    before_action :find_host
+
+    def index
+      render json: proxy.keys(@host)
+    end
+
+    def show
+      render json: proxy.key(@host, params[:id])
+    end
+
+    private
+
+    def proxy
+      ::ProxyAPI::Hdm.new(url: @host.hdm_proxy.url)
+    end
+
+    def find_host
+      @host = ::Host.friendly.find(params[:host_id])
+    end
+  end
+end

data/app/services/proxy_api/hdm.rb

@@ -0,0 +1,16 @@
+module ProxyAPI
+  class Hdm < Resource
+    def initialize(args)
+      @url = "#{args[:url]}/hdm/"
+      super
+    end
+
+    def keys(host)
+      get("/nodes/#{host.fqdn}/keys")
+    end
+
+    def key(host, key)
+      get("/nodes/#{host.fqdn}/keys/#{key}")
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+ForemanHdm::Engine.routes.draw do
+  constraints(id: %r{[^/]+}, host_id: %r{[^/]+}) do
+    resources :hosts, only: [], controller: '/hosts' do
+      resources :keys, only: %i[index show]
+    end
+  end
+end
+
+Foreman::Application.routes.draw do
+  mount ForemanHdm::Engine, at: '/foreman_hdm'
+end

data/db/migrate/20230519125201_add_hdm_proxy_id_to_hosts.rb

@@ -0,0 +1,5 @@
+class AddHdmProxyIdToHosts < ActiveRecord::Migration[6.1]
+  def change
+    add_column :hosts, :hdm_proxy_id, :integer
+  end
+end

data/db/seeds.d/75-hdm_seeds.rb

@@ -0,0 +1 @@
+Feature.where(name: 'Hdm').first_or_create

data/lib/foreman_hdm/engine.rb

@@ -0,0 +1,48 @@
+module ForemanHdm
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanHdm
+    engine_name 'foreman_hdm'
+    # register_gettext
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/overrides"]
+
+    # Add any db migrations
+    initializer 'foreman_hdm.load_app_instance_data' do |app|
+      ForemanHdm::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_hdm.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_hdm do
+        requires_foreman '>= 3.4.0'
+
+        # Add Global files for extending foreman-core components and routes
+        register_global_js_file 'global'
+
+        # Add permissions
+        security_block :foreman_hdm do
+          permission :view_foreman_hdm, { :'foreman_hdm/keys' => %i[index show] }
+        end
+
+        # Add a new role called 'Discovery' if it doesn't exist
+        role 'ForemanHdm', [:view_foreman_hdm]
+
+        smart_proxy_for Host, :hdm_proxy,
+          feature: 'Hdm',
+          label: N_('HDM Proxy'),
+          description: N_('Smart proxy to access HDM'),
+          api_description: N_('ID of HDM Proxy')
+      end
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanHdm::Engine.load_seed
+      end
+    end
+  end
+end

data/lib/foreman_hdm/version.rb

@@ -0,0 +1,3 @@
+module ForemanHdm
+  VERSION = '0.1.0'.freeze
+end

data/lib/foreman_hdm.rb

@@ -0,0 +1,4 @@
+require 'foreman_hdm/engine'
+
+module ForemanHdm
+end

data/lib/tasks/foreman_hdm_tasks.rake

@@ -0,0 +1,39 @@
+require 'rake/testtask'
+
+# Tests
+namespace :test do
+  desc 'Test ForemanHdm'
+  Rake::TestTask.new(:foreman_hdm) 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
+
+namespace :foreman_hdm do
+  desc 'Lint with rubocop'
+  task rubocop: :environment do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_hdm) do |task|
+        task.patterns = ["#{ForemanHdm::Engine.root}/app/**/*.rb",
+                         "#{ForemanHdm::Engine.root}/lib/**/*.rb",
+                         "#{ForemanHdm::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_hdm'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_hdm']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_hdm', 'foreman_hdm:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# 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 = foreman_hdm
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.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))
+
+%.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:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	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, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_hdm.po

@@ -0,0 +1,19 @@
+# foreman_hdm
+#
+# This file is distributed under the same license as foreman_hdm.
+#
+#, 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_hdm.pot

@@ -0,0 +1,19 @@
+# foreman_hdm
+#
+# This file is distributed under the same license as foreman_hdm.
+#
+#, 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_hdm.gemspec
+_('TODO: Description of ForemanHdm.')

data/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "foreman_hdm",
+  "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",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "create-react-component": "yo react-domain"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_hdm.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_hdm/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/stories": "^7.0.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_hdm_factories.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :host do
+    name 'foreman_hdm'
+  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_hdm_test.rb

@@ -0,0 +1,11 @@
+require 'test_plugin_helper'
+
+class ForemanHdmTest < 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,30 @@
+import React from 'react';
+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';
+import HdmTab from './src/Extends/Host/HdmTab';
+import "./src/Extends/index";
+
+// register reducers
+Object.entries(reducers).forEach(([key, reducer]) =>
+    registerReducer(key, reducer)
+);
+
+// register client routes
+registerRoutes('PluginHdm', 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);
+addGlobalFill(
+  "host-details-page-tabs",
+  "HDM",
+  <HdmTab key="hdm-fill-root" />,
+  490,
+  {
+    title: __('HDM'),
+    hideTab: ({hostDetails}) => (hostDetails.hdm_proxy == null)
+  }, 
+);

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,7 @@
+import componentRegistry from 'foremanReact/components/componentRegistry';
+
+// register components for erb mounting
+// componentRegistry.register({
+//     name: 'ExtendedEmptyState',
+//     type: ExtendedEmptyState,
+// });

data/webpack/src/Extends/Host/HdmTab/Hierarchies.js

@@ -0,0 +1,82 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { STATUS } from 'foremanReact/constants';
+import { Divider, EmptyStateIcon, Title } from '@patternfly/react-core';
+import { ExclamationCircleIcon } from '@patternfly/react-icons';
+import EmptyState from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
+import { global_danger_color_200 as dangerColor } from '@patternfly/react-tokens';
+import Skeleton from 'react-loading-skeleton';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import Hierarchy from './Hierarchy';
+
+const Hierarchies = ({ hostname, keyName }) => {
+  let hierarchies = [];
+
+  if (keyName) {
+    const url = `${window.location.origin.toString()}/foreman_hdm/hosts/${hostname}/keys/${keyName}`;
+    const { response, status } = useAPI('get', url);
+
+    if (status === STATUS.PENDING) {
+      return <Skeleton count={5} />;
+    }
+
+    if (status === STATUS.ERROR) {
+      const description = __('Could not fetch HDM data.');
+      const icon = (
+        <EmptyStateIcon icon={ExclamationCircleIcon} color={dangerColor.value} />
+      );
+      return (
+        <EmptyState header={__('Error!')} icon={icon} description={description} />
+      );
+    }
+
+    if (Array.isArray(response)) {
+      hierarchies = response.map((item) => {
+        return (
+          <div keyName={item.hierarchy_name}>
+            <Hierarchy hierarchy={item} />
+          </div>
+        );
+      });
+    }
+  }
+
+  const header = () => {
+    if (keyName) {
+      const prefix = __("Key: ");
+      return (
+        <div>
+          <Title headingLevel="h2">
+            <b>{prefix}</b>
+            {keyName}
+          </Title>
+          <Divider className="pf-u-mb-md" />
+        </div>
+      );
+    } else {
+      const message = __("Please select a key from the list on the left.");
+      return (
+        <EmptyState header={__('No key selected')} description={message} />
+      );
+    }
+  }
+
+  return (
+    <div>
+      {header()}
+      {hierarchies}
+    </div>
+  );
+};
+
+Hierarchies.propTypes = {
+  hostname: PropTypes.string,
+  keyName: PropTypes.string
+};
+
+Hierarchies.defaultProps = {
+  hostname: "",
+  keyName: null
+};
+
+export default Hierarchies;

data/webpack/src/Extends/Host/HdmTab/Hierarchy.js

@@ -0,0 +1,70 @@
+import React from 'react';
+import { Accordion, AccordionItem, AccordionContent, AccordionToggle, AccordionExpandedContentBody, CodeBlock, CodeBlockCode, Title } from '@patternfly/react-core';
+
+const Hierarchy = ({ hierarchy }) => {
+  const [expanded, setExpanded] = React.useState([]);
+
+  const toggle = id => {
+    const index = expanded.indexOf(id);
+    const newExpanded =
+      index >= 0 ? [...expanded.slice(0, index), ...expanded.slice(index + 1, expanded.length)] : [...expanded, id];
+    setExpanded(newExpanded);
+  };
+
+  const valueContent = (value) => {
+    if (value) {
+      return (
+        <CodeBlock>
+          <CodeBlockCode>{value}</CodeBlockCode>
+        </CodeBlock>
+      );
+    } else {
+      const message = __("No value present");
+      return (<div>{message}</div>);
+    }
+  };
+
+  const formattedPath = (file) => {
+    if (file.value) {
+      return (
+        <span>{file.path}</span>
+      );
+    } else {
+      return (
+        <em className="pf-u-disabled-color-100">{file.path}</em>
+      );
+    }
+  };
+
+  const accordionItems = hierarchy.files.map((file) => {
+    const value = valueContent(file.value);
+    const id = `${file.path}-toggle`;
+    const path = formattedPath(file);
+
+    return (
+      <AccordionItem>
+        <AccordionToggle
+          onClick={() => toggle(id)}
+          isExpanded={expanded.includes(id)}
+          id={id}
+        >
+          {path}
+        </AccordionToggle>
+        <AccordionContent id={`${id}-content`} isHidden={!expanded.includes(id)} isFixed>
+          {value}
+        </AccordionContent>
+      </AccordionItem>
+    );
+  });
+  return (
+    <div className="pf-u-mb-sm">
+      <Title headingLevel="h3">{hierarchy.hierarchy_name}</Title>
+
+      <Accordion isBordered>
+        {accordionItems}
+      </Accordion>
+    </div>
+  );
+};
+
+export default Hierarchy;