foreman_statistics 0.1.0 → 1.1.0

data/locale/gemspec.rb

@@ -1,2 +1,2 @@
 # Matches foreman_statistics.gemspec
-_('TODO: Description of ForemanStatistics.')
+_('Statistics and Trends for Foreman gives users overview of their infrastructure.')

data/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "foreman_statistics",
+  "version": "1.0.0",
+  "description": "DESCRIPTION",
+  "main": "index.js",
+  "scripts": {
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --plugin",
+    "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_statistics.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_statistics/issues"
+  },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 4.0.2"
+  },
+  "dependencies": {
+    "react-intl": "^2.8.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.7.0",
+    "@theforeman/builder": "^4.0.2",
+    "@theforeman/eslint-plugin-foreman": "4.0.5",
+    "@theforeman/stories": "^4.0.2",
+    "@theforeman/test": "^4.0.2",
+    "@theforeman/vendor-dev": "^4.0.2",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
+    "prettier": "^1.13.5",
+    "stylelint-config-standard": "^18.0.0",
+    "stylelint": "^9.3.0"
+  }
+}

data/test/functional/foreman_statistics/api/v2/statistics_controller_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../../../test_plugin_helper'
+require 'test_statistics_helper'
 
 class ForemanStatistics::Api::V2::StatisticsControllerTest < ActionController::TestCase
   setup do

data/test/functional/foreman_statistics/api/v2/trends_controller_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../../../test_plugin_helper'
+require 'test_statistics_helper'
 
 class ForemanStatistics::Api::V2::TrendsControllerTest < ActionController::TestCase
   setup do

data/test/functional/foreman_statistics/statistics_controller_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_plugin_helper'
+require 'test_statistics_helper'
 
 module ForemanStatistics
   class StatisticsControllerTest < ActionController::TestCase
@@ -7,16 +7,14 @@ module ForemanStatistics
     end
 
     test 'user with viewer rights should succeed in viewing statistics' do
-      @request.session[:user] = users(:one).id
-      users(:one).roles = [Role.default, Role.find_by(name: 'Viewer')]
-      get :index, session: set_session_user
+      setup_user('view', 'statistics')
+      get :index, session: set_session_user(:one)
       assert_response :success
     end
 
     test 'user with viewer rights should succeed in requesting statistics data via ajax' do
-      @request.session[:user] = users(:one).id
-      users(:one).roles = [Role.default, Role.find_by(name: 'Viewer')]
-      get :show, params: { :id => 'operatingsystem', :format => 'json' }, session: set_session_user
+      setup_user('view', 'statistics')
+      get :show, params: { :id => 'operatingsystem', :format => 'json' }, session: set_session_user(:one)
       assert_response :success
     end
   end

data/test/functional/foreman_statistics/trends_controller_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_plugin_helper'
+require 'test_statistics_helper'
 
 module ForemanStatistics
   class TrendsControllerTest < ActionController::TestCase
@@ -46,14 +46,14 @@ module ForemanStatistics
         test 'should render correct per_page value' do
           get :index, params: { per_page: entries_per_page + 1 }, session: set_session_user
           assert_response :success
-          per_page_results = response.body.scan(/perPage":\d+/).first.gsub(/[^\d]/, '').to_i
+          per_page_results = response.body.scan(/perPage&quot;:(\d+)/).first.first.to_i
           assert_equal entries_per_page, per_page_results
         end
 
         test 'should render per page dropdown with correct values' do
           get :index, params: { per_page: entries_per_page + 1 }, session: set_session_user
           assert_response :success
-          assert_not_nil response.body['perPageOptions":[5,6,10,15,25,50]']
+          assert_not_nil response.body['perPageOptions&quot;:[5,6,10,15,25,50]']
         end
 
         test 'sort links should include per page param' do

data/test/models/foreman_statistics/trend_counter_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_statistics_helper'
 
 module ForemanStatistics
   class TrendCounterTest < ActiveSupport::TestCase

data/test/models/foreman_statistics/trend_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_plugin_helper'
+require 'test_statistics_helper'
 
 module ForemanStatistics
   class TrendTest < ActiveSupport::TestCase

data/test/unit/foreman_statistics/access_permissions_test.rb

@@ -1,4 +1,4 @@
-require 'test_plugin_helper'
+require 'test_statistics_helper'
 require 'unit/shared/access_permissions_test_base'
 
 # Permissions are added in AccessPermissions with lists of controllers and

data/test/unit/foreman_statistics/statistics_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_plugin_helper'
+require 'test_statistics_helper'
 
 module ForemanStatistics
   class StatisticsTest < ActiveSupport::TestCase

data/test/unit/foreman_statistics_test.rb

@@ -1,4 +1,4 @@
-require 'test_plugin_helper'
+require 'test_statistics_helper'
 
 class ForemanStatisticsTest < ActiveSupport::TestCase
   setup do

data/test/unit/tasks/foreman_statistics_tasks_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_statistics_helper'
 require 'rake'
 
 class ForemanStatisticsTasksTest < ActiveSupport::TestCase

data/webpack/__mocks__/foremanReact/API.js

@@ -0,0 +1,7 @@
+export default {
+  get: jest.fn(),
+  put: jest.fn(),
+  post: jest.fn(),
+  delete: jest.fn(),
+  patch: jest.fn(),
+};

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

@@ -0,0 +1,24 @@
+import React, { useEffect } from 'react';
+
+export const callOnMount = callback => WrappedComponent => componentProps => {
+  // fires callback onMount, [] means don't listen to any props change
+  useEffect(() => {
+    callback(componentProps);
+  }, [componentProps]);
+
+  return <WrappedComponent {...componentProps} />;
+};
+
+export const withRenderHandler = ({
+  Component,
+  LoadingComponent = () => jest.fn(),
+  ErrorComponent = () => jest.fn(),
+  EmptyComponent = () => jest.fn(),
+}) => componentProps => {
+  const { isLoading, hasData, hasError } = componentProps;
+
+  if (isLoading && !hasData) return <LoadingComponent {...componentProps} />;
+  if (hasError) return <ErrorComponent {...componentProps} />;
+  if (hasData) return <Component {...componentProps} />;
+  return <EmptyComponent {...componentProps} />;
+};

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

@@ -0,0 +1,3 @@
+export const translate = s => s;
+
+export const documentLocale = () => 'en';

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

@@ -0,0 +1 @@
+export const noop = Function.prototype;

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

@@ -0,0 +1 @@
+export const getURIsearch = () => 'a=b';

data/webpack/__mocks__/foremanReact/components/ChartBox/index.js

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

data/webpack/__mocks__/foremanReact/components/ForemanModal/ForemanModalActions.js

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

data/webpack/__mocks__/foremanReact/components/ForemanModal/ForemanModalHooks.js

@@ -0,0 +1,10 @@
+const modalOpen = true;
+const setModalOpen = jest.fn();
+const setModalClosed = jest.fn();
+
+export const useForemanModal = () => ({
+  modalOpen,
+  setModalOpen,
+  setModalClosed,
+});
+export default useForemanModal;

data/webpack/__mocks__/foremanReact/components/ForemanModal/index.js

@@ -0,0 +1,4 @@
+const ForemanModal = () => jest.fn();
+ForemanModal.Header = () => jest.fn();
+ForemanModal.Footer = () => jest.fn();
+export default ForemanModal;

data/webpack/__mocks__/foremanReact/components/Layout/LayoutActions.js

@@ -0,0 +1,2 @@
+export const showLoading = () => null;
+export const hideLoading = () => null;

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/EmptyState.js

@@ -0,0 +1,5 @@
+const EmptyState = () => jest.fn();
+
+export const EmptyStatePattern = () => jest.fn();
+
+export default EmptyState;

data/webpack/__mocks__/foremanReact/components/common/MessageBox.js

@@ -0,0 +1,4 @@
+import React from 'react';
+
+export const MessageBox = () => <div className="message-box-root" />;
+export default MessageBox;

data/webpack/__mocks__/foremanReact/components/common/dates/LongDateTime.js

@@ -0,0 +1,5 @@
+import React from 'react';
+
+export const LongDateTime = value => <p>{value}</p>;
+
+export default LongDateTime;

data/webpack/__mocks__/foremanReact/components/common/dates/RelativeDateTime.js

@@ -0,0 +1,3 @@
+import React from 'react';
+
+export default date => <p>{`${date} time ago`}</p>;

data/webpack/__mocks__/foremanReact/components/common/table.js

@@ -0,0 +1,5 @@
+import React from 'react';
+
+export const Table = () => <div className="table" />;
+export const createTableReducer = jest.fn(controller => controller);
+export const cellFormatter = cell => cell;

data/webpack/__mocks__/foremanReact/components/common/table/actionsHelpers/actionTypeCreator.js

@@ -0,0 +1,7 @@
+const createTableActionTypes = tableID => ({
+  REQUEST: `${tableID.toUpperCase()}_REQUEST`,
+  SUCCESS: `${tableID.toUpperCase()}_SUCCESS`,
+  FAILURE: `${tableID.toUpperCase()}_FAILURE`,
+});
+
+export default createTableActionTypes;

data/webpack/__mocks__/foremanReact/constants.js

@@ -0,0 +1,24 @@
+export const STATUS = {
+  PENDING: 'PENDING',
+  RESOLVED: 'RESOLVED',
+  ERROR: 'ERROR',
+};
+
+export const getControllerSearchProps = (
+  controller,
+  id = 'searchBar',
+  canCreateBookmarks = true
+) => ({
+  controller,
+  autocomplete: {
+    id,
+    searchQuery: '',
+    url: `${controller}/auto_complete_search`,
+    useKeyShortcuts: true,
+  },
+  bookmarks: {
+    url: '/api/bookmarks',
+    canCreateBookmarks,
+    documentationUrl: `4.1.5Searching`,
+  },
+});

data/webpack/__mocks__/foremanReact/readme.md

@@ -0,0 +1,11 @@
+For testing components which have imported foreman-core components,
+a mock file is required in this folder.
+
+### Example: Mocking ForemanModal component
+```js
+//  __mocks__/foremanReact/components/ForemanModal/index.js
+const ForemanModal = () => jest.fn();
+ForemanModal.Header = () => jest.fn();
+ForemanModal.Footer = () => jest.fn();
+export default ForemanModal;
+```

data/webpack/__mocks__/foremanReact/redux/actions/toasts.js

@@ -0,0 +1,8 @@
+export const addToast = toast => ({
+  type: 'TOASTS_ADD',
+  payload: {
+    message: toast,
+  },
+});
+
+export default addToast;

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

@@ -0,0 +1,10 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+const PageLayout = ({ children }) => <div>{children}</div>;
+
+PageLayout.propTypes = {
+  children: PropTypes.node.isRequired,
+};
+
+export default PageLayout;

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

@@ -0,0 +1,5 @@
+import React from 'react';
+
+const ExportButton = () => <button>export</button>;
+
+export default ExportButton;

data/webpack/__mocks__/foremanReact/routes/common/reducerHOC/withDataReducer.js

@@ -0,0 +1,35 @@
+import Immutable from 'seamless-immutable';
+
+const initialState = Immutable({
+  isLoading: true,
+  hasError: false,
+  hasData: false,
+  message: { type: 'empty', text: '' },
+});
+
+const withDataReducer = controller => (
+  state = initialState,
+  { type, payload }
+) => {
+  switch (type) {
+    case `${controller}_DATA_RESOLVED`:
+      return state.merge({ ...payload, isLoading: false });
+
+    case `${controller}_DATA_FAILED`:
+      return state.merge({ ...payload, isLoading: false, hasError: true });
+
+    case `${controller}_CLEAR_ERROR`:
+      return state.set('hasError', false);
+
+    case `${controller}_SHOW_LOADING`:
+      return state.set('isLoading', true);
+
+    case `${controller}_HIDE_LOADING`:
+      return state.set('isLoading', false);
+
+    default:
+      return state;
+  }
+};
+
+export default withDataReducer;

data/webpack/fills_index.js

@@ -0,0 +1,15 @@
+// This example for extanding foreman-core's component via slot&fill
+
+/*
+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/index.js

@@ -0,0 +1,21 @@
+/* eslint import/no-unresolved: [2, { ignore: [foremanReact/*] }] */
+/* 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 ForemanStatistics from './src/ForemanStatistics';
+import * as trends from './src/trends';
+
+Object.assign(window.tfm, { trends });
+
+// register reducers
+Object.entries(reducers).forEach(([key, reducer]) =>
+  registerReducer(key, reducer)
+);
+
+// register components for erb mounting
+componentRegistry.register({
+  name: 'ForemanStatistics',
+  type: ForemanStatistics,
+});

data/webpack/src/Components/StatisticsChartsList/StatisticsChartsList.fixtures.js

@@ -0,0 +1,19 @@
+export const statisticsData = {
+  operatingsystem: {
+    id: 'operatingsystem',
+    title: 'OS Distribution',
+    url: 'statistics/operatingsystem',
+    search: '/hosts?search=os_title=~VAL~',
+  },
+  architecture: {
+    id: 'architecture',
+    title: 'Architecture Distribution',
+    url: 'statistics/architecture',
+    search: '/hosts?search=facts.architecture=~VAL~',
+  },
+};
+
+export const statisticsMeta = [
+  statisticsData.operatingsystem,
+  statisticsData.architecture,
+];