foreman_puppet 3.0.7 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 772e941b4202bbfdde858905799bfeea60fa6709ba5e473041b514f8a90697a8
-  data.tar.gz: 967448785c3adaddf2987365df7f990794d5c354160d78feb4e546472399bca4
+  metadata.gz: ad4345e5b4481b1263e0d9a6af568f6d899288fb6e25843dbc0bb5cabf86b5b9
+  data.tar.gz: 61e41f2886a32d9b73b42513b69d1eb5f0ba28b3151a68c0be21a14b62ca039f
 SHA512:
-  metadata.gz: 742a59e022663c55a15838049c8eaf5827180a0abcfa8989759a409c40b3bf59f912e8deeaf5ebd730dbb16787698968e0ed71879d9183c2f14c99a7780e648a
-  data.tar.gz: 4c32122d44b7cf75abdcfa1119c9cda80771b43511fa575bb8f155015ee5b191f3d1f8420072a32e749487da777bd719ca301bbc794e65d50af8edddf90f00ce
+  metadata.gz: ae6266081bbf344be643d88bbd57dfa2a8028f897dee6df45d6e08d5c7bddc451cae45b49759c484d8561a84fd8d96b35636fc5aa4165df49193e5b17d65edc8
+  data.tar.gz: 829314db4098020a1471276f94f6f1e8bc3421f7f3c1af3d5d08228f4ac811e999c5ce48bade42871a86775f9e630f40e991044a4411a07fb343a9ed8f9a2811

data/README.md

@@ -37,6 +37,7 @@ You can install it on Foreman 2.5 to prepare for the Foreman update.
 
 |Foreman version|Plugin version|Notes                                     |
 |---------------|--------------|------------------------------------------|
+| >= 3.3        | ~> 4.0       | Required                                 |
 | >= 3.2        | ~> 3.0       | Required                                 |
 | ~> 3.1        | ~> 2.0       | Required                                 |
 | ~> 3.0        | ~> 1.0       | Required                                 |
@@ -78,7 +79,7 @@ Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) *2021* *The Foreman developers*
+Copyright (c) *2022* *The Foreman developers*
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/lib/foreman_puppet/engine.rb

@@ -58,6 +58,7 @@ module ForemanPuppet
       ::Api::V2::TemplateCombinationsController.include ForemanPuppet::Extensions::ApiTemplateCombinationsController
       ::Api::V2::HostsController.include ForemanPuppet::Extensions::ParametersHost
       ::Api::V2::HostgroupsController.include ForemanPuppet::Extensions::ParametersHostgroup
+      ::ComputeResourcesVmsController.helper ForemanPuppet::HostsAndHostgroupsHelper
       ::OperatingsystemsController.prepend ForemanPuppet::Extensions::OperatingsystemsController
       ::HostsController.include ForemanPuppet::Extensions::HostsControllerExtensions
       ::HostsController.include ForemanPuppet::Extensions::ParametersHost

data/lib/foreman_puppet/register.rb

@@ -1,7 +1,7 @@
 Foreman::Plugin.register :foreman_puppet do
-  requires_foreman '>= 3.0.0'
+  requires_foreman '>= 3.3.0'
   # Add Global JS file for extending foreman-core components and routes
-  register_global_js_file 'fills'
+  register_global_js_file 'global'
 
   settings do
     category(:facts, N_('Facts')) do

data/lib/foreman_puppet/version.rb

@@ -1,3 +1,3 @@
 module ForemanPuppet
-  VERSION = '3.0.7'.freeze
+  VERSION = '4.0.2'.freeze
 end

data/package.json

@@ -21,17 +21,17 @@
     "url": "http://projects.theforeman.org/projects/foreman_puppet/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": "^8.15.0"
+    "@theforeman/vendor": "^10.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
     "@sheerun/mutationobserver-shim": "^0.3.3",
-    "@theforeman/builder": "^8.15.0",
-    "@theforeman/eslint-plugin-foreman": "^8.15.0",
-    "@theforeman/find-foreman": "^8.15.0",
-    "@theforeman/stories": "^8.15.0",
-    "@theforeman/test": "^8.15.0",
-    "@theforeman/vendor-dev": "^8.15.0",
+    "@theforeman/builder": "^10.1.0",
+    "@theforeman/eslint-plugin-foreman": "^10.1.0",
+    "@theforeman/find-foreman": "^10.1.0",
+    "@theforeman/stories": "^10.1.0",
+    "@theforeman/test": "^10.1.0",
+    "@theforeman/vendor-dev": "^10.1.0",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "jed": "^1.1.1",

data/test/controllers/foreman_puppet/api/v2/override_values_controller_test.rb

@@ -75,8 +75,12 @@ module ForemanPuppet
               post :create, params: { smart_class_parameter_id: lookup_key.id, override_value: override_value }
             end
             response = ActiveSupport::JSON.decode(@response.body)
-            param_not_posted = (override_value.keys.first.to_s == 'match') ? 'Value' : 'Match' # The opposite of override_value is missing
-            assert_match(/Validation failed: #{param_not_posted} can't be blank/, response['error']['message'])
+            if override_value.keys.first.to_s == 'match'
+              # The opposite of override_value is missing and should fail
+              assert_match(/Validation failed: Value can't be blank/, response['error']['message'])
+            else # match is missing
+              assert_match(/Failed to save the record/, response['error']['message'])
+            end
             assert_response :error
           end
         end

data/test/models/foreman_puppet/host_test.rb

@@ -110,6 +110,12 @@ module ForemanPuppet
     end
 
     describe '#info puppet bits' do
+      test 'ENC YAML omits environment if no puppet facet' do
+        host = FactoryBot.build_stubbed(:host)
+        enc = host.info
+        assert_not_includes enc.keys, 'environment'
+      end
+
       test 'ENC YAML uses Classification::ClassParam for parameterized output' do
         skip 'No idea whats wrong here'
         host = FactoryBot.build_stubbed(:host, :with_environment)

data/webpack/global_index.js

@@ -0,0 +1,11 @@
+import { registerReducer } from 'foremanReact/common/MountingService';
+import reducers from './src/reducers';
+import { registerFills } from './src/Extends/Fills';
+import { registerLegacy } from './legacy';
+
+// register reducers
+registerReducer('puppet', reducers);
+// add fills
+registerFills();
+// TODO: the checkForUnavailablePuppetclasses is very nasty
+registerLegacy();

data/webpack/index.js

@@ -2,16 +2,9 @@
 /* eslint-disable import/no-extraneous-dependencies */
 /* eslint-disable import/extensions */
 import componentRegistry from 'foremanReact/components/componentRegistry';
-import { registerReducer } from 'foremanReact/common/MountingService';
-import reducers from './src/reducers';
 import ForemanPuppet from './src/ForemanPuppet';
 import { WelcomeEnv } from './src/Components/Environments/Welcome';
 
-// register reducers
-Object.entries(reducers).forEach(([key, reducer]) =>
-  registerReducer(key, reducer)
-);
-
 // register components for erb mounting
 componentRegistry.register({ name: 'WelcomeEnv', type: WelcomeEnv });
 componentRegistry.register({ name: 'ForemanPuppet', type: ForemanPuppet });

data/webpack/legacy.js

@@ -0,0 +1,31 @@
+import $ from 'jquery';
+import * as classEditor from './src/foreman_class_edit';
+import * as hostForm from './src/foreman_puppet_host_form';
+
+export const registerLegacy = () => {
+  window.tfm = Object.assign(window.tfm || {}, {
+    classEditor,
+    puppetEnc: {
+      hostForm,
+    },
+  });
+
+  // TODO: the checkForUnavailablePuppetclasses is very nasty
+  $(document)
+    .on('change', '.hostgroup-select', evt => {
+      const form = $('form.host-form')[0];
+      if (form && form.dataset.id) hostForm.updatePuppetclasses(evt.target);
+    })
+    .on('change', '.interface_domain', evt => {
+      hostForm.reloadPuppetclassParams();
+    })
+    .on('change', '.host-architecture-os-select', evt => {
+      hostForm.reloadPuppetclassParams();
+    })
+    .on('ContentLoad', evt => {
+      hostForm.checkForUnavailablePuppetclasses();
+    });
+  $(window).on('load', evt => {
+    hostForm.checkForUnavailablePuppetclasses();
+  });
+};

data/webpack/src/Extends/Fills/index.js

@@ -0,0 +1,26 @@
+import React from 'react';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+import PuppetTab from '../Host/PuppetTab';
+
+const fills = [
+  {
+    slot: 'host-details-page-tabs',
+    name: 'Puppet',
+    component: props => <PuppetTab {...props} />,
+    weight: 500,
+    metadata: { title: __('Puppet') },
+  },
+];
+
+export const registerFills = () => {
+  fills.forEach(({ slot, name, component: Component, weight, metadata }) =>
+    addGlobalFill(
+      slot,
+      name,
+      <Component key={`puppet-fill-${name}`} />,
+      weight,
+      metadata
+    )
+  );
+};

data/webpack/src/Extends/Host/PuppetTab/Routes.js

@@ -0,0 +1,46 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import { Route, Switch, Redirect } from 'react-router-dom';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { route } from './helpers';
+import EmptyPage from './SubTabs/EmptyPage';
+import Reports from './SubTabs/Reports';
+import ENCPreview from './SubTabs/ENCPreview';
+
+const SecondaryTabRoutes = ({ hostName, hostInfo, status }) => (
+  <Switch>
+    <Route path={route('reports')}>
+      <Reports hostName={hostName} hostInfo={hostInfo} status={status} />
+    </Route>
+    <Route path={route('assigned')}>
+      <EmptyPage
+        header={__('Assigned classes')}
+        description={__('This tab is still a work in progress')}
+      />
+    </Route>
+    <Route path={route('smart-classes')}>
+      <EmptyPage
+        header={__('Smart class parameters')}
+        description={__('This tab is still a work in progress')}
+      />
+    </Route>
+    <Route path={route('yaml')}>
+      <ENCPreview hostName={hostName} />
+    </Route>
+    <Redirect to={route('reports')} />
+  </Switch>
+);
+
+SecondaryTabRoutes.propTypes = {
+  hostName: PropTypes.string,
+  hostInfo: PropTypes.object,
+  status: PropTypes.string,
+};
+
+SecondaryTabRoutes.defaultProps = {
+  hostName: '',
+  hostInfo: {},
+  status: undefined,
+};
+
+export default SecondaryTabRoutes;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/ENCPreview/ENCTab.js

@@ -0,0 +1,61 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {
+  CodeBlock,
+  CodeBlockAction,
+  CodeBlockCode,
+  ClipboardCopyButton,
+} from '@patternfly/react-core';
+
+export const ENCTab = ({ encData }) => {
+  const [copied, setCopied] = React.useState(false);
+
+  const code = `${encData}`;
+
+  const clipboardCopyFunc = (event, text) => {
+    const clipboard = event.currentTarget.parentElement;
+    const el = document.createElement('textarea');
+    el.value = text.toString();
+    clipboard.appendChild(el);
+    el.select();
+    document.execCommand('copy');
+    clipboard.removeChild(el);
+  };
+
+  const onClick = (event, text) => {
+    clipboardCopyFunc(event, text);
+    setCopied(true);
+  };
+
+  const actions = (
+    <CodeBlockAction>
+      <ClipboardCopyButton
+        id="copy-button"
+        textId="code-content"
+        aria-label="Copy to clipboard"
+        onClick={e => onClick(e, code)}
+        exitDelay={600}
+        maxWidth="110px"
+        variant="plain"
+      >
+        {copied ? 'Successfully copied to clipboard!' : 'Copy to clipboard'}
+      </ClipboardCopyButton>
+    </CodeBlockAction>
+  );
+
+  return (
+    <CodeBlock actions={actions}>
+      <CodeBlockCode id="code-content">{code}</CodeBlockCode>
+    </CodeBlock>
+  );
+};
+
+ENCTab.propTypes = {
+  encData: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
+};
+
+ENCTab.defaultProps = {
+  encData: undefined,
+};
+
+export default ENCTab;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/ENCPreview/index.js

@@ -0,0 +1,56 @@
+import React from 'react';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import PropTypes from 'prop-types';
+
+import Skeleton from 'react-loading-skeleton';
+import EmptyState from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
+import { STATUS } from 'foremanReact/constants';
+import { EmptyStateIcon } from '@patternfly/react-core';
+import { ExclamationCircleIcon } from '@patternfly/react-icons';
+import { global_danger_color_200 as dangerColor } from '@patternfly/react-tokens';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { ENCTab } from './ENCTab';
+
+const ENCPreview = ({ hostName }) => {
+  const options = {
+    params: { name: hostName, format: 'yml' },
+    key: 'PUPPET_ENC_PREVIEW',
+  };
+  const url = `${window.location.origin.toString()}/foreman_puppet/hosts/${hostName}/externalNodes`;
+  const { response, status } = useAPI('get', url, options);
+
+  if (status === STATUS.PENDING) {
+    return <Skeleton count={5} />;
+  }
+
+  if (status === STATUS.ERROR || !hostName) {
+    const description = !hostName
+      ? __("Couldn't find any ENC data for this host")
+      : response?.response?.data?.message;
+    const icon = (
+      <EmptyStateIcon icon={ExclamationCircleIcon} color={dangerColor.value} />
+    );
+    return (
+      <EmptyState header={__('Error!')} icon={icon} description={description} />
+    );
+  }
+  if (response !== '' || response !== undefined) {
+    return (
+      <div className="enc-preview-tab" padding="16px 24px">
+        <ENCTab encData={response} />
+      </div>
+    );
+  }
+
+  return null;
+};
+
+ENCPreview.propTypes = {
+  hostName: PropTypes.string,
+};
+
+ENCPreview.defaultProps = {
+  hostName: undefined,
+};
+
+export default ENCPreview;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/EmptyPage.js

@@ -0,0 +1,20 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import PFEmptyPage from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
+
+const EmptyPage = ({ header, description }) => (
+  <div className="host-details-tab-item">
+    <PFEmptyPage icon="enterprise" header={header} description={description} />
+  </div>
+);
+
+EmptyPage.propTypes = {
+  header: PropTypes.string.isRequired,
+  description: PropTypes.string,
+};
+
+EmptyPage.defaultProps = {
+  description: null,
+};
+
+export default EmptyPage;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/Reports/components/DescriptionCard.js

@@ -0,0 +1,88 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import CardTemplate from 'foremanReact/components/HostDetails/Templates/CardItem/CardTemplate';
+import {
+  DescriptionList,
+  DescriptionListTerm,
+  DescriptionListGroup,
+  DescriptionListDescription,
+} from '@patternfly/react-core';
+import SkeletonLoader from 'foremanReact/components/common/SkeletonLoader';
+import DefaultLoaderEmptyState from 'foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState';
+import { STATUS } from 'foremanReact/constants';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+const DescriptionCard = ({
+  proxyName,
+  caProxy,
+  proxyId,
+  caProxyId,
+  env,
+  status,
+}) => (
+  <CardTemplate header={__('Puppet details')} expandable>
+    <DescriptionList isCompact>
+      <DescriptionListGroup>
+        <DescriptionListTerm>{__('Puppet environment')}</DescriptionListTerm>
+        <DescriptionListDescription>
+          <SkeletonLoader
+            emptyState={<DefaultLoaderEmptyState />}
+            status={status}
+          >
+            {env && (
+              <a href={`/foreman_puppet/environments/?search=name+%3D+${env}`}>
+                {env}
+              </a>
+            )}
+          </SkeletonLoader>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>{__('Puppet Smart Proxy')}</DescriptionListTerm>
+        <DescriptionListDescription>
+          <SkeletonLoader
+            emptyState={<DefaultLoaderEmptyState />}
+            status={status}
+          >
+            {proxyName && (
+              <a href={`/smart_proxies/${proxyId}#puppet`}>{proxyName}</a>
+            )}
+          </SkeletonLoader>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>{__('Puppet CA Smart Proxy')}</DescriptionListTerm>
+        <DescriptionListDescription>
+          <SkeletonLoader
+            emptyState={<DefaultLoaderEmptyState />}
+            status={status}
+          >
+            {caProxy && (
+              <a href={`/smart_proxies/${caProxyId}#puppet-ca`}>{caProxy}</a>
+            )}
+          </SkeletonLoader>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+    </DescriptionList>
+  </CardTemplate>
+);
+
+DescriptionCard.propTypes = {
+  caProxy: PropTypes.string,
+  caProxyId: PropTypes.number,
+  env: PropTypes.string,
+  proxyId: PropTypes.number,
+  proxyName: PropTypes.string,
+  status: PropTypes.string,
+};
+
+DescriptionCard.defaultProps = {
+  caProxy: undefined,
+  caProxyId: undefined,
+  env: undefined,
+  proxyId: undefined,
+  proxyName: undefined,
+  status: STATUS.PENDING,
+};
+
+export default DescriptionCard;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/Reports/index.js

@@ -0,0 +1,50 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import { Grid, GridItem } from '@patternfly/react-core';
+import ReportsTab from 'foremanReact/components/HostDetails/Tabs/ReportsTab';
+import DescriptionCard from './components/DescriptionCard';
+import './styles.scss';
+
+const Reports = ({
+  hostName,
+  status,
+  hostInfo: {
+    puppet_proxy_name: proxyName,
+    puppet_ca_proxy_name: caProxy,
+    environment_name: env,
+    puppet_proxy_id: proxyId,
+    puppet_ca_proxy_id: caProxyId,
+  },
+}) => (
+  <div className="report-tab">
+    <Grid hasGutter>
+      <GridItem span={4}>
+        <DescriptionCard
+          proxyName={proxyName}
+          caProxy={caProxy}
+          proxyId={proxyId}
+          caProxyId={caProxyId}
+          env={env}
+          status={status}
+        />
+      </GridItem>
+      <GridItem span={12}>
+        <ReportsTab hostName={hostName} origin="Puppet" />
+      </GridItem>
+    </Grid>
+  </div>
+);
+
+Reports.propTypes = {
+  hostName: PropTypes.string,
+  hostInfo: PropTypes.object,
+  status: PropTypes.string,
+};
+
+Reports.defaultProps = {
+  hostName: undefined,
+  hostInfo: {},
+  status: undefined,
+};
+
+export default Reports;

data/webpack/src/Extends/Host/PuppetTab/SubTabs/Reports/styles.scss

@@ -0,0 +1,7 @@
+.report-tab {
+  padding: 16px 24px;
+
+  .pf-c-card {
+    height: 100%;
+  }
+}

data/webpack/src/Extends/Host/PuppetTab/constants.js

@@ -0,0 +1,8 @@
+import { translate as __ } from 'foremanReact/common/I18n';
+
+export const SECONDARY_TABS = [
+  { key: 'reports', title: __('Reports') },
+  { key: 'assigned', title: __('Assigned classes') },
+  { key: 'smart-classes', title: __('Smart class parameters') },
+  { key: 'yaml', title: __('ENC Preview') },
+];

data/webpack/src/Extends/Host/PuppetTab/helpers.js

@@ -0,0 +1,3 @@
+export const hashRoute = subpath => `#/Puppet/${subpath}`;
+export const route = subpath => hashRoute(subpath).substring(1);
+export const activeTab = path => path.split('/')[2];

data/webpack/src/Extends/Host/PuppetTab/index.js

@@ -0,0 +1,51 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { useHistory } from 'react-router-dom';
+import { Tabs, Tab, TabTitleText } from '@patternfly/react-core';
+import { STATUS } from 'foremanReact/constants';
+
+import SecondaryTabRoutes from './Routes';
+import { activeTab } from './helpers';
+import { SECONDARY_TABS } from './constants';
+
+const PuppetTab = ({ response, status, location: { pathname } }) => {
+  const hashHistory = useHistory();
+  return (
+    <>
+      <Tabs
+        className="margin-0-24"
+        onSelect={(evt, subTab) => hashHistory.push(subTab)}
+        isSecondary
+        activeKey={activeTab(pathname)}
+      >
+        {SECONDARY_TABS.map(({ key, title }) => (
+          <Tab
+            key={key}
+            eventKey={key}
+            title={<TabTitleText>{title}</TabTitleText>}
+          />
+        ))}
+      </Tabs>
+      <SecondaryTabRoutes
+        hostName={response.name}
+        hostInfo={response}
+        status={status}
+      />
+    </>
+  );
+};
+
+PuppetTab.propTypes = {
+  response: PropTypes.object,
+  status: PropTypes.string,
+  location: PropTypes.shape({
+    pathname: PropTypes.string,
+  }),
+};
+PuppetTab.defaultProps = {
+  location: { pathname: '' },
+  response: { name: '' },
+  status: STATUS.PENDING,
+};
+
+export default PuppetTab;