foreman_remote_execution 3.3.2 → 4.0.0

data/webpack/react_app/components/TargetingHosts/TargetingHostsHelpers.js

@@ -0,0 +1,10 @@
+import { getURI } from 'foremanReact/common/urlHelpers';
+
+export const getApiUrl = (searchQuery, pagination) => {
+  const baseUrl = getURI()
+    .search('')
+    .addQuery('page', pagination.page)
+    .addQuery('per_page', pagination.perPage);
+
+  return searchQuery ? baseUrl.addQuery('search', searchQuery) : baseUrl;
+};

data/webpack/react_app/components/TargetingHosts/TargetingHostsPage.js

@@ -0,0 +1,62 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Grid } from 'patternfly-react';
+
+import SearchBar from 'foremanReact/components/SearchBar';
+import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import { getControllerSearchProps } from 'foremanReact/constants';
+
+import TargetingHosts from './TargetingHosts';
+import './TargetingHostsPage.scss';
+
+const TargetingHostsPage = ({
+  handleSearch,
+  searchQuery,
+  apiStatus,
+  items,
+  totalHosts,
+  pagination,
+  handlePagination,
+}) => (
+  <div id="targeting_hosts">
+    <Grid.Row>
+      <Grid.Col md={6} className="title_filter">
+        <SearchBar
+          onSearch={query => handleSearch(query)}
+          data={{
+            ...getControllerSearchProps('hosts'),
+            autocomplete: {
+              id: 'targeting_hosts_search',
+              searchQuery,
+              url: '/hosts/auto_complete_search',
+              useKeyShortcuts: true,
+            },
+            bookmarks: {},
+          }}
+        />
+      </Grid.Col>
+    </Grid.Row>
+    <br />
+    <TargetingHosts apiStatus={apiStatus} items={items} />
+    <Pagination
+      viewType="list"
+      itemCount={totalHosts}
+      pagination={pagination}
+      onChange={args => handlePagination(args)}
+      dropdownButtonId="targeting-hosts-pagination-dropdown"
+      className="targeting-hosts-pagination"
+    />
+  </div>
+);
+
+TargetingHostsPage.propTypes = {
+  handleSearch: PropTypes.func.isRequired,
+  searchQuery: PropTypes.string.isRequired,
+  apiStatus: PropTypes.string.isRequired,
+  items: PropTypes.array.isRequired,
+  totalHosts: PropTypes.number.isRequired,
+  pagination: PropTypes.object.isRequired,
+  handlePagination: PropTypes.func.isRequired,
+};
+
+export default TargetingHostsPage;

data/webpack/react_app/components/TargetingHosts/TargetingHostsPage.scss

@@ -0,0 +1,6 @@
+.targeting-hosts-pagination {
+  margin-top: -7px;
+}
+#targeting_hosts {
+  min-height: 350px;
+}

data/webpack/react_app/components/TargetingHosts/TargetingHostsSelectors.js

@@ -2,11 +2,19 @@ import {
   selectAPIStatus,
   selectAPIResponse,
 } from 'foremanReact/redux/API/APISelectors';
+import { selectDoesIntervalExist } from 'foremanReact/redux/middlewares/IntervalMiddleware/IntervalSelectors';
+
 import { TARGETING_HOSTS } from './TargetingHostsConsts';
 
 export const selectItems = state =>
   selectAPIResponse(state, TARGETING_HOSTS).hosts || [];
 
 export const selectAutoRefresh = state =>
-  selectAPIResponse(state, TARGETING_HOSTS).autoRefresh;
-export const selectStatus = state => selectAPIStatus(state, TARGETING_HOSTS);
+  selectAPIResponse(state, TARGETING_HOSTS).autoRefresh || '';
+
+export const selectApiStatus = state => selectAPIStatus(state, TARGETING_HOSTS);
+export const selectTotalHosts = state =>
+  selectAPIResponse(state, TARGETING_HOSTS).total_hosts || 0;
+
+export const selectIntervalExists = state =>
+  selectDoesIntervalExist(state, TARGETING_HOSTS);

data/webpack/react_app/components/TargetingHosts/__tests__/TargetingHostsPage.test.js

@@ -0,0 +1,9 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import TargetingHostsPage from '../TargetingHostsPage';
+import { TargetingHostsPageFixtures } from './fixtures';
+
+describe('TargetingHostsPage', () =>
+  testComponentSnapshotsWithFixtures(
+    TargetingHostsPage,
+    TargetingHostsPageFixtures
+  ));

data/webpack/react_app/components/TargetingHosts/__tests__/TargetingHostsSelectors.test.js

@@ -0,0 +1,26 @@
+import { testSelectorsSnapshotWithFixtures } from '@theforeman/test';
+
+import {
+  selectItems,
+  selectAutoRefresh,
+  selectApiStatus,
+  selectTotalHosts,
+  selectIntervalExists,
+} from '../TargetingHostsSelectors';
+
+const state = {
+  hosts: [],
+  autoRefresh: 'true',
+  total_hosts: 0,
+};
+
+const fixtures = {
+  'should return hosts': () => selectItems(state),
+  'should return autoRefresh': () => selectAutoRefresh(state),
+  'should return apiStatus': () => selectApiStatus(state),
+  'should return totalHosts': () => selectTotalHosts(state),
+  'should return intervalExists': () => selectIntervalExists(state),
+};
+
+describe('TargetingHostsSelectors', () =>
+  testSelectorsSnapshotWithFixtures(fixtures));

data/webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHosts.test.js.snap

@@ -33,6 +33,13 @@ exports[`TargetingHosts renders 1`] = `
           name="host"
           status="success"
         />
+        <HostItem
+          actions={Array []}
+          key="host2"
+          link="/link2"
+          name="host2"
+          status="success"
+        />
       </tbody>
     </table>
   </div>
@@ -74,7 +81,15 @@ exports[`TargetingHosts renders with loading 1`] = `
           </th>
         </tr>
       </thead>
-      <tbody />
+      <tbody>
+        <tr>
+          <td
+            colSpan="3"
+          >
+            No hosts found.
+          </td>
+        </tr>
+      </tbody>
     </table>
   </div>
 </LoadingState>

data/webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsPage.test.js.snap

@@ -0,0 +1,68 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`TargetingHostsPage renders 1`] = `
+<div
+  id="targeting_hosts"
+>
+  <Row
+    bsClass="row"
+    componentClass="div"
+  >
+    <Col
+      bsClass="col"
+      className="title_filter"
+      componentClass="div"
+      md={6}
+    >
+      <SearchBar
+        data={
+          Object {
+            "autocomplete": Object {
+              "id": "targeting_hosts_search",
+              "searchQuery": "",
+              "url": "/hosts/auto_complete_search",
+              "useKeyShortcuts": true,
+            },
+            "bookmarks": Object {},
+            "controller": "hosts",
+          }
+        }
+        onSearch={[Function]}
+      />
+    </Col>
+  </Row>
+  <br />
+  <TargetingHosts
+    apiStatus="RESOLVED"
+    items={
+      Array [
+        Object {
+          "actions": Array [],
+          "link": "/link",
+          "name": "host",
+          "status": "success",
+        },
+        Object {
+          "actions": Array [],
+          "link": "/link2",
+          "name": "host2",
+          "status": "success",
+        },
+      ]
+    }
+  />
+  <PaginationWrapper
+    className="targeting-hosts-pagination"
+    dropdownButtonId="targeting-hosts-pagination-dropdown"
+    itemCount={1}
+    onChange={[Function]}
+    pagination={
+      Object {
+        "page": 1,
+        "perPage": 20,
+      }
+    }
+    viewType="list"
+  />
+</div>
+`;

data/webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsSelectors.test.js.snap

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`TargetingHostsSelectors should return apiStatus 1`] = `"RESOLVED"`;
+
+exports[`TargetingHostsSelectors should return autoRefresh 1`] = `"true"`;
+
+exports[`TargetingHostsSelectors should return hosts 1`] = `Array []`;
+
+exports[`TargetingHostsSelectors should return intervalExists 1`] = `false`;
+
+exports[`TargetingHostsSelectors should return totalHosts 1`] = `0`;

data/webpack/react_app/components/TargetingHosts/__tests__/fixtures.js

@@ -1,3 +1,18 @@
+const items = [
+  {
+    name: 'host',
+    link: '/link',
+    status: 'success',
+    actions: [],
+  },
+  {
+    name: 'host2',
+    link: '/link2',
+    status: 'success',
+    actions: [],
+  },
+];
+
 export const HostItemFixtures = {
   renders: {
     name: 'Host1',
@@ -15,29 +30,30 @@ export const HostStatusFixtures = {
 
 export const TargetingHostsFixtures = {
   renders: {
-    status: '',
-    items: [
-      {
-        name: 'host',
-        link: '/link',
-        status: 'success',
-        actions: [],
-      },
-    ],
+    apiStatus: 'RESOLVED',
+    items,
   },
   'renders with error': {
-    status: 'ERROR',
-    items: [
-      {
-        name: 'host',
-        link: '/link',
-        status: 'success',
-        actions: [],
-      },
-    ],
+    apiStatus: 'ERROR',
+    items,
   },
   'renders with loading': {
-    status: '',
+    apiStatus: 'PENDING',
     items: [],
   },
 };
+
+export const TargetingHostsPageFixtures = {
+  renders: {
+    handleSearch: () => {},
+    searchQuery: '',
+    apiStatus: 'RESOLVED',
+    items,
+    totalHosts: 1,
+    pagination: {
+      page: 1,
+      perPage: 20,
+    },
+    handlePagination: () => {},
+  },
+};

data/webpack/react_app/components/TargetingHosts/index.js

@@ -1,37 +1,97 @@
-import React, { useEffect } from 'react';
+import React, { useEffect, useState } from 'react';
 import { useSelector, useDispatch } from 'react-redux';
-import { stopInterval } from 'foremanReact/redux/middlewares/IntervalMiddleware';
-import TargetingHosts from './TargetingHosts';
+
+import { get } from 'foremanReact/redux/API';
+import { useForemanSettings } from 'foremanReact/Root/Context/ForemanContext';
+import {
+  withInterval,
+  stopInterval,
+} from 'foremanReact/redux/middlewares/IntervalMiddleware';
 
 import {
   selectItems,
-  selectStatus,
+  selectApiStatus,
   selectAutoRefresh,
+  selectTotalHosts,
+  selectIntervalExists,
 } from './TargetingHostsSelectors';
-import { getData } from './TargetingHostsActions';
+import { getApiUrl } from './TargetingHostsHelpers';
 import { TARGETING_HOSTS } from './TargetingHostsConsts';
+import TargetingHostsPage from './TargetingHostsPage';
 
 const WrappedTargetingHosts = () => {
   const dispatch = useDispatch();
+  const { perPage, perPageOptions } = useForemanSettings();
+
   const autoRefresh = useSelector(selectAutoRefresh);
   const items = useSelector(selectItems);
-  const status = useSelector(selectStatus);
+  const apiStatus = useSelector(selectApiStatus);
+  const totalHosts = useSelector(selectTotalHosts);
+  const [searchQuery, setSearchQuery] = useState('');
+  const [pagination, setPagination] = useState({
+    page: 1,
+    perPage,
+    perPageOptions,
+  });
+  const [apiUrl, setApiUrl] = useState(getApiUrl(searchQuery, pagination));
+  const intervalExists = useSelector(selectIntervalExists);
 
-  useEffect(() => {
-    dispatch(getData());
+  const handleSearch = query => {
+    const defaultPagination = { page: 1, perPage: pagination.perPage };
+    stopApiInterval();
 
-    return () => {
+    setApiUrl(getApiUrl(query, defaultPagination));
+    setSearchQuery(query);
+    setPagination(defaultPagination);
+  };
+
+  const handlePagination = args => {
+    stopApiInterval();
+    setPagination(args);
+    setApiUrl(getApiUrl(searchQuery, args));
+  };
+
+  const stopApiInterval = () => {
+    if (intervalExists) {
       dispatch(stopInterval(TARGETING_HOSTS));
-    };
-  }, [dispatch]);
+    }
+  };
+
+  const getData = url =>
+    withInterval(
+      get({
+        key: TARGETING_HOSTS,
+        url,
+        handleError: () => {
+          dispatch(stopInterval(TARGETING_HOSTS));
+        },
+      }),
+      1000
+    );
 
   useEffect(() => {
+    dispatch(getData(apiUrl));
+
     if (autoRefresh === 'false') {
       dispatch(stopInterval(TARGETING_HOSTS));
     }
-  }, [autoRefresh, dispatch]);
 
-  return <TargetingHosts status={status} items={items} />;
+    return () => {
+      dispatch(stopInterval(TARGETING_HOSTS));
+    };
+  }, [dispatch, apiUrl, autoRefresh]);
+
+  return (
+    <TargetingHostsPage
+      handleSearch={handleSearch}
+      searchQuery={searchQuery}
+      apiStatus={apiStatus}
+      items={items}
+      totalHosts={totalHosts}
+      pagination={pagination}
+      handlePagination={handlePagination}
+    />
+  );
 };
 
 export default WrappedTargetingHosts;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -249,6 +249,7 @@ files:
 - app/views/job_invocations/new.html.erb
 - app/views/job_invocations/refresh.js.erb
 - app/views/job_invocations/show.html.erb
+- app/views/job_invocations/show.js.erb
 - app/views/job_invocations/show.json.erb
 - app/views/job_invocations/welcome.html.erb
 - app/views/job_templates/_custom_tab_headers.html.erb
@@ -322,7 +323,9 @@ files:
 - db/migrate/20180411160809_add_sudo_password_to_job_invocation.rb
 - db/migrate/20180913101042_add_randomized_ordering_to_targeting.rb
 - db/migrate/20190111153330_remove_remote_execution_without_proxy_setting.rb
+- db/migrate/20200623073022_rename_sudo_password_to_effective_user_password.rb
 - db/seeds.d/100-assign_features_with_templates.rb
+- db/seeds.d/20-permissions.rb
 - db/seeds.d/50-notification_blueprints.rb
 - db/seeds.d/60-ssh_proxy_feature.rb
 - db/seeds.d/70-job_templates.rb
@@ -376,6 +379,7 @@ files:
 - test/functional/job_templates_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
 - test/models/orchestration/ssh_test.rb
+- test/support/remote_execution_helper.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb
@@ -394,19 +398,29 @@ files:
 - test/unit/targeting_test.rb
 - test/unit/template_invocation_input_value_test.rb
 - webpack/__mocks__/foremanReact/common/I18n.js
+- webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js
+- webpack/__mocks__/foremanReact/components/SearchBar.js
 - webpack/__mocks__/foremanReact/components/common/ActionButtons/ActionButtons.js
 - webpack/__mocks__/foremanReact/constants.js
+- webpack/__mocks__/foremanReact/redux/API/APISelectors.js
+- webpack/__mocks__/foremanReact/redux/middlewares/IntervalMiddleware/IntervalSelectors.js
 - webpack/index.js
 - webpack/react_app/components/TargetingHosts/TargetingHosts.js
-- webpack/react_app/components/TargetingHosts/TargetingHostsActions.js
 - webpack/react_app/components/TargetingHosts/TargetingHostsConsts.js
+- webpack/react_app/components/TargetingHosts/TargetingHostsHelpers.js
+- webpack/react_app/components/TargetingHosts/TargetingHostsPage.js
+- webpack/react_app/components/TargetingHosts/TargetingHostsPage.scss
 - webpack/react_app/components/TargetingHosts/TargetingHostsSelectors.js
 - webpack/react_app/components/TargetingHosts/__tests__/HostItem.test.js
 - webpack/react_app/components/TargetingHosts/__tests__/HostStatus.test.js
 - webpack/react_app/components/TargetingHosts/__tests__/TargetingHosts.test.js
+- webpack/react_app/components/TargetingHosts/__tests__/TargetingHostsPage.test.js
+- webpack/react_app/components/TargetingHosts/__tests__/TargetingHostsSelectors.test.js
 - webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/HostItem.test.js.snap
 - webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/HostStatus.test.js.snap
 - webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHosts.test.js.snap
+- webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsPage.test.js.snap
+- webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsSelectors.test.js.snap
 - webpack/react_app/components/TargetingHosts/__tests__/fixtures.js
 - webpack/react_app/components/TargetingHosts/components/HostItem.js
 - webpack/react_app/components/TargetingHosts/components/HostStatus.js
@@ -459,6 +473,7 @@ test_files:
 - test/functional/job_templates_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
 - test/models/orchestration/ssh_test.rb
+- test/support/remote_execution_helper.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb