foreman_templates 7.0.1 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3d99a3a9b934e72af1a294ed64800987d0d4913
-  data.tar.gz: 5607d7eb373e637899574268fcf523a77f2dc513
+  metadata.gz: 799e5dc7d9045fbb1bcb6571584f705e3965c324
+  data.tar.gz: 71e4088ec73d0f103ee812952acbe2333264eebc
 SHA512:
-  metadata.gz: 441f75e022ec3e8c82dabbd4dc11c2edb7af7e2d881b633f7b57419b7b8406acde65de22e873d40af8f72e5d6953756aec7493cc1d87cab1296279c57f9eaa4d
-  data.tar.gz: e7b27d7302206e2924560f2c0a56a3a4d1b32cbaee79146e98c9370947c74fa8d2d751cd0043990ca5a2a5b012aaa675023ee9d81abb264c7b2f690961d70c81
+  metadata.gz: 89b63e0f1f73daed9c3cdfd1d78092d6733656169370cf976590099c4263972ed274c1c9a5dddf7eb629b0b9e61207434f7bfb94664b5e62171e1e4f219c1295
+  data.tar.gz: 0ce7b7cd05ecbd305a16444d80e57ecc85251eff82d0eec8d36f29f49f311203308171831fb807461bed587f64635fc5c088dfa14abafbd7458cd2e5f9557236

data/.babelrc

@@ -0,0 +1,16 @@
+{
+  "presets": ["env", "react"],
+  "plugins": [
+    "transform-class-properties",
+    "transform-object-rest-spread",
+    "transform-object-assign"
+  ],
+  "env": {
+    "test": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"]
+    },
+    "storybook": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"]
+    }
+  }
+}

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '7.0.1'.freeze
+  VERSION = '7.0.2'.freeze
 end

data/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "foreman_templates",
+  "version": "0.0.1",
+  "description": "This plugin will sync the contents of the Foreman Community Templates [repository](https://github.com/theforeman/community-templates/) (or a git repo of your choice) to your local Foreman instance",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "node node_modules/.bin/jest webpack",
+    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_templates.git"
+  },
+  "author": "The Foreman team",
+  "license": "GPL-3.0",
+  "bugs": {
+    "url": "https://projects.theforeman.org"
+  },
+  "homepage": "https://github.com/theforeman/foreman_templates",
+  "dependencies": {
+    "@theforeman/vendor": "^1.7.0"
+  },
+  "devDependencies": {
+    "@theforeman/vendor-dev": "^1.7.0",
+    "babel-eslint": "^8.2.1",
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "babel-plugin-transform-object-assign": "^6.22.0",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-preset-env": "^1.6.0",
+    "babel-preset-react": "^6.24.1",
+    "enzyme": "^3.7.0",
+    "enzyme-adapter-react-16": "^1.7.0",
+    "enzyme-to-json": "^3.3.5",
+    "eslint": "^4.18.1",
+    "eslint-config-airbnb": "^16.0.0",
+    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-jest": "^21.2.0",
+    "eslint-plugin-jsx-a11y": "^6.0.2",
+    "eslint-plugin-patternfly-react": "^0.2.1",
+    "eslint-plugin-react": "^7.4.0",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^23.6.0",
+    "prettier": "^1.16.4",
+    "react-redux-test-utils": "^0.1.1"
+  },
+  "jest": {
+    "verbose": true,
+    "moduleDirectories": [
+      "node_modules/@theforeman/vendor-core/node_modules",
+      "node_modules",
+      "webpack"
+    ],
+    "setupFiles": [
+      "raf/polyfill",
+      "./webpack/testSetup.js"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "<rootDir>/foreman/"
+    ],
+    "moduleNameMapper": {
+      "^.+\\.(css|scss)$": "identity-obj-proxy"
+    }
+  }
+}

data/webpack/ForemanTemplates.js

@@ -0,0 +1,29 @@
+import React from 'react';
+import { BrowserRouter as Router } from 'react-router-dom';
+import PropTypes from 'prop-types';
+
+import Routes from './Routes';
+
+const ForemanTemplates = ({ data }) => (
+  <Router>
+    <Routes
+      apiUrls={data.apiUrls}
+      validationData={data.validationData}
+      editPaths={data.editPaths}
+      fileRepoStartWith={data.fileRepoStartWith}
+      userPermissions={data.userPermissions}
+    />
+  </Router>
+);
+
+ForemanTemplates.propTypes = {
+  data: PropTypes.shape({
+    apiUrls: PropTypes.object,
+    validationData: PropTypes.object,
+    editPaths: PropTypes.object,
+    userPermissions: PropTypes.object,
+    fileRepoStartWith: PropTypes.array,
+  }).isRequired,
+};
+
+export default ForemanTemplates;

data/webpack/Routes.js

@@ -0,0 +1,33 @@
+import React from 'react';
+import { Route, Switch } from 'react-router-dom';
+
+import NewTemplateSync from './components/NewTemplateSync';
+import TemplateSyncResult from './components/TemplateSyncResult';
+import PageNotFound from './components/PageNotFound';
+
+const links = [
+  {
+    title: 'New Template Sync',
+    path: 'template_syncs',
+    Component: NewTemplateSync,
+  },
+  {
+    title: 'Template Sync Result',
+    path: 'template_syncs/result',
+    Component: TemplateSyncResult,
+  },
+];
+
+export default data => (
+  <Switch>
+    {links.map(({ path, Component }) => (
+      <Route
+        exact
+        key={path}
+        path={`/${path}`}
+        render={props => <Component {...props} {...data} />}
+      />
+    ))}
+    <Route component={PageNotFound} />
+  </Switch>
+);

data/webpack/__mocks__/foremanReact/common/helpers.js

@@ -0,0 +1,27 @@
+import { camelCase } from 'lodash';
+
+export const propsToCamelCase = ob =>
+  propsToCase(camelCase, 'propsToCamelCase only takes objects', ob);
+
+export const deepPropsToCamelCase = obj => {
+  if (typeof obj !== 'object' || obj === null) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(deepPropsToCamelCase);
+  }
+  const transformed = propsToCamelCase(obj);
+  return Object.keys(transformed).reduce((memo, key) => {
+    memo[key] = deepPropsToCamelCase(transformed[key]);
+    return memo;
+  }, {});
+};
+
+const propsToCase = (casingFn, errorMsg, ob) => {
+  if (typeof ob !== 'object') throw Error(errorMsg);
+
+  return Object.keys(ob).reduce((memo, key) => {
+    memo[casingFn(key)] = ob[key];
+    return memo;
+  }, {});
+};

data/webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js

@@ -0,0 +1,2 @@
+const PaginationWrapper = () => jest.fn();
+export default PaginationWrapper;

data/webpack/__mocks__/foremanReact/components/common/forms/CommonForm.js

@@ -0,0 +1,2 @@
+const CommonForm = () => jest.fn();
+export default CommonForm;

data/webpack/__mocks__/foremanReact/components/common/forms/Form.js

@@ -0,0 +1,2 @@
+const Form = () => jest.fn();
+export default Form;

data/webpack/__mocks__/foremanReact/components/common/forms/TextField.js

@@ -0,0 +1,2 @@
+const TextField = () => jest.fn();
+export default TextField;

data/webpack/__mocks__/foremanReact/redux/actions/common/forms.js

@@ -0,0 +1 @@
+export default {};

data/webpack/__mocks__/foremanReact/routes/common/PageLayout/PageLayout.js

@@ -0,0 +1,2 @@
+const PageLayout = () => jest.fn();
+export default PageLayout;

data/webpack/__tests__/__snapshots__/helpers.test.js.snap

@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`withProtectedView should return protected component 1`] = `<ProtectedComponent />`;
+
+exports[`withProtectedView should return protection component 1`] = `<ProtectionComponent />`;

data/webpack/__tests__/helpers.test.js

@@ -0,0 +1,17 @@
+import React from 'react';
+import { testSelectorsSnapshotWithFixtures } from 'react-redux-test-utils';
+import withProtectedView from '../withProtectedView';
+
+const ProtectedComponent = () => <div>Protected component</div>;
+
+const ProtectionComponent = () => <div>Protection component</div>;
+
+const fixtures = {
+  'should return protected component': () =>
+    withProtectedView(ProtectedComponent, ProtectionComponent, () => true)(),
+  'should return protection component': () =>
+    withProtectedView(ProtectedComponent, ProtectionComponent, () => false)(),
+};
+
+describe('withProtectedView', () =>
+  testSelectorsSnapshotWithFixtures(fixtures));

data/webpack/components/NewTemplateSync/NewTemplateSync.js

@@ -0,0 +1,60 @@
+import React from 'react';
+import { LoadingState } from 'patternfly-react';
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import PropTypes from 'prop-types';
+
+import NewTemplateSyncForm from './components/NewTemplateSyncForm';
+import './NewTemplateSync.scss';
+
+class NewTemplateSync extends React.Component {
+  componentDidMount() {
+    const {
+      apiUrls: { syncSettingsUrl },
+      getSyncSettings,
+    } = this.props;
+    getSyncSettings(syncSettingsUrl);
+  }
+
+  render() {
+    const {
+      apiUrls: { importUrl, exportUrl },
+      loadingSettings,
+      history,
+      validationData,
+      userPermissions,
+    } = this.props;
+
+    return (
+      <LoadingState loading={loadingSettings}>
+        <PageLayout
+          header={__('Import or Export Templates')}
+          searchable={false}
+        >
+          <NewTemplateSyncForm
+            validationData={validationData}
+            importUrl={importUrl}
+            exportUrl={exportUrl}
+            history={history}
+            userPermissions={userPermissions}
+          />
+        </PageLayout>
+      </LoadingState>
+    );
+  }
+}
+
+NewTemplateSync.propTypes = {
+  getSyncSettings: PropTypes.func.isRequired,
+  apiUrls: PropTypes.object.isRequired,
+  userPermissions: PropTypes.object.isRequired,
+  history: PropTypes.object,
+  validationData: PropTypes.object,
+  loadingSettings: PropTypes.bool.isRequired,
+};
+
+NewTemplateSync.defaultProps = {
+  validationData: {},
+  history: {},
+};
+
+export default NewTemplateSync;

data/webpack/components/NewTemplateSync/NewTemplateSync.scss

@@ -0,0 +1,19 @@
+@import '~@theforeman/vendor/scss/variables';
+
+.left-padded {
+  padding-left: 3%;
+}
+
+#foreman-templates {
+  .loading-state-pf.loading-state-pf-lg {
+    padding-top: 5%;
+  }
+  // No need to hide content, see #26122
+  #main > #content {
+    display: block;
+  }
+
+  .blank-slate-pf {
+    padding-top: 5%;
+  }
+}

data/webpack/components/NewTemplateSync/NewTemplateSyncActions.js

@@ -0,0 +1,39 @@
+import api from 'foremanReact/API';
+import { deepPropsToCamelCase } from 'foremanReact/common/helpers';
+
+import {
+  SYNC_SETTINGS_REQUEST,
+  SYNC_SETTINGS_SUCCESS,
+  SYNC_SETTINGS_FAILURE,
+  SYNC_RESULT_PAGINATION_CHANGE,
+} from '../../consts';
+
+import { initialState } from '../TemplateSyncResult/TemplateSyncResultReducer';
+
+export const getSyncSettings = url => async dispatch => {
+  dispatch({ type: SYNC_SETTINGS_REQUEST });
+
+  try {
+    const { data } = await api.get(url);
+    dispatch({
+      type: SYNC_RESULT_PAGINATION_CHANGE,
+      payload: { pagination: initialState.pagination },
+    });
+    return dispatch({
+      type: SYNC_SETTINGS_SUCCESS,
+      payload: {
+        ...deepPropsToCamelCase(data),
+      },
+    });
+  } catch (error) {
+    return dispatch(errorHandler(SYNC_SETTINGS_FAILURE, error));
+  }
+};
+
+const errorHandler = (msg, err) => {
+  const error = {
+    errorMsg: 'Failed to fetch Settings for template sync from server.',
+    statusText: err.response.statusText,
+  };
+  return { type: msg, payload: { error } };
+};

data/webpack/components/NewTemplateSync/NewTemplateSyncReducer.js

@@ -0,0 +1,34 @@
+import Immutable from 'seamless-immutable';
+
+import {
+  SYNC_SETTINGS_REQUEST,
+  SYNC_SETTINGS_SUCCESS,
+  SYNC_SETTINGS_FAILURE,
+} from '../../consts';
+
+export const initialState = Immutable({
+  loadingSettings: false,
+  importSettings: [],
+  exportSettings: [],
+  error: '',
+});
+
+const syncSettings = (state = initialState, action) => {
+  const { payload } = action;
+  switch (action.type) {
+    case SYNC_SETTINGS_REQUEST:
+      return state.set('loadingSettings', true);
+    case SYNC_SETTINGS_SUCCESS:
+      return state.merge({
+        loadingSettings: false,
+        importSettings: payload.results.import,
+        exportSettings: payload.results.export,
+      });
+    case SYNC_SETTINGS_FAILURE:
+      return state.merge({ error: payload.error, loadingSettings: false });
+    default:
+      return state;
+  }
+};
+
+export default syncSettings;

data/webpack/components/NewTemplateSync/NewTemplateSyncSelectors.js

@@ -0,0 +1,7 @@
+export const newSyncState = state => state.foremanTemplates.syncSettings;
+
+export const selectImportSettings = state => newSyncState(state).importSettings;
+export const selectExportSettings = state => newSyncState(state).exportSettings;
+export const selectLoadingSettings = state =>
+  newSyncState(state).loadingSettings;
+export const selectError = state => newSyncState(state).error;

data/webpack/components/NewTemplateSync/__fixtures__/templateSyncSettings.fixtures.js

@@ -0,0 +1,71 @@
+import Immutable from 'seamless-immutable';
+
+export const associateSetting = Immutable({
+  id: 45,
+  value: 'new',
+  settingsType: 'string',
+  name: 'associate',
+  selection: [
+    { value: 'new', label: 'New' },
+    { value: 'never', label: 'Never' },
+    { value: 'always', label: 'Always' },
+  ],
+});
+
+export const forceSetting = Immutable({
+  id: 46,
+  value: false,
+  settingsType: 'bool',
+  name: 'force',
+});
+
+export const importSettings = [associateSetting, forceSetting];
+
+export const filterSetting = Immutable({
+  id: 47,
+  value: '',
+  settingsType: 'string',
+  name: 'filter',
+});
+
+export const negateSetting = Immutable({
+  id: 48,
+  value: false,
+  settingsType: 'bool',
+  name: 'negate',
+});
+
+export const repoSetting = Immutable({
+  id: 49,
+  value: 'https://github.com/theforeman/community-templates.git',
+  settingsType: 'string',
+  name: 'repo',
+});
+
+export const exportSettings = [filterSetting, negateSetting, repoSetting];
+
+const registeredSettings = settings =>
+  settings.reduce((memo, item) => {
+    memo[item.name] = item;
+    return memo;
+  }, {});
+
+export const registeredImportSettings = {
+  registeredFields: registeredSettings(importSettings),
+};
+export const registeredExportSettings = {
+  registeredFields: registeredSettings(exportSettings),
+};
+
+export const initialValues = {
+  initial: importSettings.concat(exportSettings).reduce((memo, item) => {
+    memo[item.name] = item.value;
+    return memo;
+  }, {}),
+};
+
+export const stateFactory = obj => ({
+  foremanTemplates: {
+    syncSettings: obj,
+  },
+});

data/webpack/components/NewTemplateSync/__tests__/NewTemplateSync.test.js

@@ -0,0 +1,31 @@
+import { testComponentSnapshotsWithFixtures } from 'react-redux-test-utils';
+
+import NewTemplateSync from '../NewTemplateSync';
+
+jest.mock('foremanReact/routes/common/PageLayout/PageLayout');
+
+const noop = () => {};
+
+const commonFixture = {
+  apiUrls: {},
+  getSyncSettings: noop,
+  validationData: {},
+  userPermissions: {
+    import: true,
+    export: true,
+  },
+};
+
+const fixtures = {
+  'should render when loaded': {
+    loadingSettings: false,
+    ...commonFixture,
+  },
+  'should render when loading': {
+    loadingSettings: true,
+    ...commonFixture,
+  },
+};
+
+describe('NewTemplateSync', () =>
+  testComponentSnapshotsWithFixtures(NewTemplateSync, fixtures));

data/webpack/components/NewTemplateSync/__tests__/NewTemplateSyncReducer.test.js

@@ -0,0 +1,55 @@
+import { testReducerSnapshotWithFixtures } from 'react-redux-test-utils';
+
+import reducer, { initialState } from '../NewTemplateSyncReducer';
+
+import {
+  importSettings,
+  exportSettings,
+} from '../__fixtures__/templateSyncSettings.fixtures';
+import {
+  SYNC_SETTINGS_REQUEST,
+  SYNC_SETTINGS_SUCCESS,
+  SYNC_SETTINGS_FAILURE,
+} from '../../../consts';
+
+const successPayload = {
+  results: {
+    import: importSettings,
+    export: exportSettings,
+  },
+};
+
+const fixtures = {
+  'should return initial state': {
+    state: initialState,
+    action: {
+      type: undefined,
+      payload: {},
+    },
+  },
+  'should start loading on setting values request': {
+    state: initialState,
+    action: {
+      type: SYNC_SETTINGS_REQUEST,
+    },
+  },
+  'should stop loading on setting values success': {
+    state: initialState.set('loadingSettings', true),
+    action: {
+      type: SYNC_SETTINGS_SUCCESS,
+      payload: successPayload,
+    },
+    'should stop loading on setting values error': {
+      state: initialState.set('loadingSettings', true),
+      action: {
+        type: SYNC_SETTINGS_FAILURE,
+        payload: {
+          error: 'Failed to fetch setting values',
+        },
+      },
+    },
+  },
+};
+
+describe('NewTemplateSyncReducer', () =>
+  testReducerSnapshotWithFixtures(reducer, fixtures));

data/webpack/components/NewTemplateSync/__tests__/NewTemplateSyncSelectors.test.js

@@ -0,0 +1,28 @@
+import { testSelectorsSnapshotWithFixtures } from 'react-redux-test-utils';
+
+import {
+  importSettings,
+  exportSettings,
+  stateFactory,
+} from '../__fixtures__/templateSyncSettings.fixtures';
+
+import {
+  selectImportSettings,
+  selectExportSettings,
+  selectLoadingSettings,
+  selectError,
+} from '../NewTemplateSyncSelectors';
+
+const fixtures = {
+  'should return import settings': () =>
+    selectImportSettings(stateFactory({ importSettings })),
+  'should return export settings': () =>
+    selectExportSettings(stateFactory({ exportSettings })),
+  'should return loading settings': () =>
+    selectLoadingSettings(stateFactory({ loadingSettings: true })),
+  'should return loading error': () =>
+    selectError(stateFactory({ error: 'Error' })),
+};
+
+describe('NewTemplateSyncSelectors', () =>
+  testSelectorsSnapshotWithFixtures(fixtures));

data/webpack/components/NewTemplateSync/__tests__/__snapshots__/NewTemplateSync.test.js.snap

@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`NewTemplateSync should render when loaded 1`] = `
+<LoadingState
+  additionalClasses=""
+  loading={false}
+  loadingText="Loading"
+  size="lg"
+  timeout={300}
+>
+  <PageLayout
+    header="Import or Export Templates"
+    searchable={false}
+  >
+    <Connect(ReduxForm)
+      history={Object {}}
+      userPermissions={
+        Object {
+          "export": true,
+          "import": true,
+        }
+      }
+      validationData={Object {}}
+    />
+  </PageLayout>
+</LoadingState>
+`;
+
+exports[`NewTemplateSync should render when loading 1`] = `
+<LoadingState
+  additionalClasses=""
+  loading={true}
+  loadingText="Loading"
+  size="lg"
+  timeout={300}
+>
+  <PageLayout
+    header="Import or Export Templates"
+    searchable={false}
+  >
+    <Connect(ReduxForm)
+      history={Object {}}
+      userPermissions={
+        Object {
+          "export": true,
+          "import": true,
+        }
+      }
+      validationData={Object {}}
+    />
+  </PageLayout>
+</LoadingState>
+`;