foreman_acd 0.0.3 → 0.3.0

data/db/migrate/20190610202252_create_app_definitions.rb

@@ -6,11 +6,9 @@ class CreateAppDefinitions < ActiveRecord::Migration[5.2]
     create_table :app_definitions do |t|
       t.string :name, :default => '', :null => false, :limit => 255, :unique => true
       t.text :description
-      t.column :hostgroup_id, :integer
-      t.text :parameters
+      t.text :services
       t.timestamps :null => true
     end
-    add_foreign_key :app_definitions, :hostgroups
   end
 
   def down

data/db/migrate/20190625140305_create_app_instances.rb

@@ -7,7 +7,7 @@ class CreateAppInstances < ActiveRecord::Migration[5.2]
       t.string :name, :default => '', :null => false, :limit => 255, :unique => true
       t.column :app_definition_id, :integer, :null => false
       t.text :description
-      t.text :parameters
+      t.text :hosts
       t.timestamps :null => true
     end
     add_foreign_key :app_instances, :app_definitions

data/db/migrate/20200916091018_create_ansible_playbooks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Adding acd ansible playbooks db table
+class CreateAnsiblePlaybooks < ActiveRecord::Migration[5.2]
+  def up
+    create_table :acd_ansible_playbooks do |t|
+      t.string :name, :default => '', :null => false, :limit => 255, :unique => true
+      t.text :description
+      t.string :scm_type
+      t.string :path
+      t.string :playfile
+      t.text :vars
+      t.timestamps :null => true
+    end
+  end
+
+  def down
+    drop_table :acd_ansible_playbooks
+  end
+end

data/db/migrate/20200917120220_add_ansible_playbook_id.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Adding acd ansible playbooks db table
+class AddAnsiblePlaybookId < ActiveRecord::Migration[5.2]
+  def up
+    add_column :app_definitions, :acd_ansible_playbook_id, :integer
+    add_foreign_key "app_definitions", "acd_ansible_playbooks", :name => "app_definitions_acd_ansible_playbooks_id_fk"
+  end
+
+  def down
+    remove_foreign_key 'app_definitions', :name => 'app_definitions_acd_ansible_playbooks_id_fk'
+    remove_column :app_definitions, :acd_ansible_playbook_id
+  end
+end

data/db/migrate/20201016002819_add_ansible_vars_all_to_app_definitions.rb

@@ -0,0 +1,5 @@
+class AddAnsibleVarsAllToAppDefinitions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :app_definitions, :ansible_vars_all, :text
+  end
+end

data/db/migrate/20201016104338_add_ansible_vars_all_to_app_instances.rb

@@ -0,0 +1,5 @@
+class AddAnsibleVarsAllToAppInstances < ActiveRecord::Migration[5.2]
+  def change
+    add_column :app_instances, :ansible_vars_all, :text
+  end
+end

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

@@ -0,0 +1,8 @@
+User.as_anonymous_admin do
+  JobTemplate.without_auditing do
+    Dir[File.join("#{ForemanAcd::Engine.root}/app/views/templates/**/*.erb")].each do |template|
+      sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
+      JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+    end
+  end
+end

data/lib/foreman_acd/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'foreman_remote_execution'
+
 module ForemanAcd
   # This engine connects ForemanAcd with Foreman core
   class Engine < ::Rails::Engine
@@ -12,6 +14,7 @@ module ForemanAcd
     config.autoload_paths += Dir["#{config.root}/app/overrides"]
     config.autoload_paths += Dir["#{config.root}/app/services"]
     config.autoload_paths += Dir["#{config.root}/app/lib"]
+    config.autoload_paths += Dir["#{config.root}/lib"]
 
     # Add any db migrations
     initializer 'foreman_acd.load_app_instance_data' do |app|

data/lib/foreman_acd/plugin.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_acd do
-  requires_foreman '>= 1.19'
+  requires_foreman '>= 2.1'
 
   apipie_documented_controllers ["#{ForemanAcd::Engine.root}/app/controllers/foreman_acd/api/v2/*.rb"]
 
   # Menus
   divider :top_menu, :parent => :configure_menu, :caption => 'Applications'
+  menu :top_menu, :ansible_playbooks,
+       :url_hash => { :controller => :'foreman_acd/ansible_playbooks', :action => :index },
+       :caption => 'Ansible Playbooks',
+       :parent => :configure_menu
+
   menu :top_menu, :app_definitions,
        :url_hash => { :controller => :'foreman_acd/app_definitions', :action => :index },
        :caption => 'App Definitions',
@@ -19,6 +24,31 @@ Foreman::Plugin.register :foreman_acd do
 
   # Add permissions
   security_block :foreman_acd do
+    permission :create_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:new, :create],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:create] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :view_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:index, :show, :auto_complete_search],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:index, :show] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :edit_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:update, :edit],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:update] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :destroy_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:destroy],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:destroy] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :import_vars_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:import_vars],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:import_vars] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
     permission :create_app_definitions,
                { :'foreman_acd/app_definitions' => [:new, :create],
                  :'foreman_acd/api/v2/app_definitions' => [:create] },
@@ -39,6 +69,16 @@ Foreman::Plugin.register :foreman_acd do
                  :'foreman_acd/api/v2/app_definitions' => [:destroy] },
                :resource_type => 'ForemanAcd::AppDefinition'
 
+    permission :export_app_definitions,
+               { :'foreman_acd/app_definitions' => [:export],
+                 :'foreman_acd/api/v2/app_definitions' => [:export] },
+               :resource_type => 'ForemanAcd::AppDefinition'
+
+    permission :import_app_definitions,
+               { :'foreman_acd/app_definitions' => [:import],
+                 :'foreman_acd/api/v2/app_definitions' => [:import] },
+               :resource_type => 'ForemanAcd::AppDefinition'
+
     permission :create_app_instances,
                { :'foreman_acd/app_instances' => [:new, :create],
                  :'foreman_acd/api/v2/app_instances' => [:create] },
@@ -63,18 +103,46 @@ Foreman::Plugin.register :foreman_acd do
                { :'foreman_acd/app_instances' => [:deploy],
                  :'foreman_acd/api/v2/app_instances' => [:deploy] },
                :resource_type => 'ForemanAcd::AppInstance'
+
+    permission :configure_app_instances,
+               { :'foreman_acd/app_instances' => [:configure],
+                 :'foreman_acd/api/v2/app_instances' => [:configure] },
+               :resource_type => 'ForemanAcd::AppInstance'
+
+    permission :report_app_instances,
+               { :'foreman_acd/app_instances' => [:report],
+                 :'foreman_acd/api/v2/app_instances' => [:report] },
+               :resource_type => 'ForemanAcd::AppInstance'
   end
 
   # Manager Role
-  role 'Application Centric Deployment Manager', [:create_app_definitions,
+  role 'Application Centric Deployment Manager', [:create_ansible_playbooks,
+                                                  :view_ansible_playbooks,
+                                                  :edit_ansible_playbooks,
+                                                  :destroy_ansible_playbooks,
+                                                  :import_vars_ansible_playbooks,
+                                                  :create_app_definitions,
                                                   :view_app_definitions,
                                                   :edit_app_definitions,
-                                                  :destroy_app_definitions]
+                                                  :destroy_app_definitions,
+                                                  :export_app_definitions,
+                                                  :import_app_definitions]
 
   # User Role
   role 'Application Centric Deployment User', [:create_app_instances,
                                                :view_app_instances,
                                                :edit_app_instances,
                                                :destroy_app_instances,
-                                               :deploy_app_instances]
+                                               :deploy_app_instances,
+                                               :configure_app_instances,
+                                               :report_app_instances]
+
+  RemoteExecutionFeature.register(
+    :run_acd_ansible_playbook,
+    N_('Run playbook for ACD'),
+    {
+      :description => N_('Run an Ansible playbook to configure ACD application'),
+      :provided_inputs => %w[application_name playbook_name playbook_path inventory_path]
+    }
+  )
 end

data/lib/foreman_acd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanAcd
-  VERSION = '0.0.3'
+  VERSION = '0.3.0'
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foreman_acd",
-  "version": "0.0.3",
+  "version": "0.3.0",
   "description": "foreman application centric deployment",
   "main": "index.js",
   "directories": {
@@ -30,6 +30,7 @@
     "eslint-plugin-patternfly-react": "^0.2.1",
     "eslint-plugin-react": "^7.4.0",
     "identity-obj-proxy": "^3.0.0",
+    "lodash": "^4.17.11",
     "jest": "^23.6.0",
     "jest-cli": "^23.6.0",
     "jest-prop-type-error": "^1.1.0",

data/webpack/components/ApplicationDefinition/ApplicationDefinition.js

@@ -0,0 +1,376 @@
+import $ from 'jquery';
+import React, { useState } from 'react'
+import PropTypes from 'prop-types';
+import {
+  Icon,
+  Button,
+} from 'patternfly-react';
+import * as resolve from 'table-resolver';
+import ForemanModal from 'foremanReact/components/ForemanModal';
+import Select from 'foremanReact/components/common/forms/Select';
+import ParameterSelection from '../ParameterSelection';
+import AddTableEntry from '../common/AddTableEntry';
+import DeleteTableEntry from '../common/DeleteTableEntry';
+import RailsData from '../common/RailsData'
+import AnsiblePlaybookSelector from './components/AnsiblePlaybookSelector';
+
+import {
+  Table,
+  FormControl,
+  inlineEditFormatterFactory,
+} from 'patternfly-react';
+
+import {
+  PARAMETER_SELECTION_PARAM_TYPE_FOREMAN,
+  PARAMETER_SELECTION_PARAM_TYPE_ANSIBLE,
+} from '../ParameterSelection/ParameterSelectionConstants';
+
+class ApplicationDefinition extends React.Component {
+
+  constructor(props) {
+    super(props);
+  }
+
+  isEditing({rowData}) {
+    return (rowData.backup !== undefined);
+  }
+
+  createAnsibleGroupObject(ansibleGroups, withAll=false) {
+    const ansibleGroupObj = {};
+
+    const ansibleGroupArray = Object.keys(ansibleGroups);
+    ansibleGroupArray.forEach(e => (ansibleGroupObj[e] = e));
+
+    if ((withAll === false) && (ansibleGroupObj.hasOwnProperty('all'))) {
+      delete ansibleGroupObj.all;
+    }
+
+    return ansibleGroupObj;
+  }
+
+  componentDidMount() {
+    const {
+      data: { mode, ansiblePlaybook, ansibleDataUrl, services, ansibleVarsAll, hostgroups },
+      initApplicationDefinition,
+      addApplicationDefinitionService,
+      deleteApplicationDefinitionService,
+      activateEditApplicationDefinitionService,
+      changeEditApplicationDefinitionService,
+      openForemanParameterSelectionModal,
+      openAnsibleParameterSelectionModal,
+      loadAnsibleData,
+    } = this.props;
+
+    const inlineEditButtonsFormatter = inlineEditFormatterFactory({
+      isEditing: additionalData => this.props.editMode,
+      renderValue: (value, additionalData) => (
+        <td style={{ padding: '2px' }}>
+          <Button
+            bsStyle="default"
+            onClick={() => activateEditApplicationDefinitionService(additionalData)}
+          >
+            <Icon type="pf" name="edit" title="edit entry" />
+          </Button>
+          &nbsp;
+          <Button
+            bsStyle="default"
+            onClick={() => openForemanParameterSelectionModal(additionalData)}
+          >
+            <Icon type="pf" name="settings" title="change parameters" />
+          </Button>
+          &nbsp;
+          <Button
+            bsStyle="default"
+            onClick={() => openAnsibleParameterSelectionModal(additionalData)}
+          >
+            <span title="change ansible variables">A</span>
+          </Button>
+          <DeleteTableEntry
+            hidden={false}
+            disabled={false}
+            onDeleteTableEntry={deleteApplicationDefinitionService}
+            additionalData={additionalData}
+          />
+        </td>
+      ),
+      renderEdit: (value, additionalData) => (
+        <td style={{ padding: '2px' }}>
+          <Button bsStyle="default" disabled>
+            <Icon type="pf" name="edit" />
+          </Button>
+          &nbsp;
+          <Button bsStyle="default" disabled>
+            <Icon type="pf" name="settings" />
+          </Button>
+          &nbsp;
+          <Button
+            bsStyle="default" disabled>
+            <span>A</span>
+          </Button>
+          <DeleteTableEntry
+            hidden={false}
+            disabled={true}
+            onDeleteTableEntry={deleteApplicationDefinitionService}
+            additionalData={additionalData}
+          />
+        </td>
+      )
+    });
+    this.inlineEditButtonsFormatter = inlineEditButtonsFormatter;
+
+    const headerFormatter = value => <Table.Heading>{value}</Table.Heading>;
+    this.headerFormatter = headerFormatter;
+
+    const inlineEditFormatterImpl = {
+      renderValue: (value, additionalData) => (
+        <td>
+          <span className="static">{value}</span>
+        </td>
+      ),
+      renderEditText: (value, additionalData, subtype='text') => (
+        <td className="editing">
+          <FormControl
+            type={subtype}
+            defaultValue={value}
+            onBlur={e => changeEditApplicationDefinitionService(e.target.value, additionalData) }
+          />
+        </td>
+      ),
+      renderEditSelect: (value, additionalData, options) => (
+        <td className="editing">
+          <Select
+            value={value.toString()}
+            onChange={e => changeEditApplicationDefinitionService(e.target.value, additionalData) }
+            options={options}
+            allowClear
+            key="key"
+          />
+        </td>
+      )
+    };
+
+    const inlineEditFormatter = inlineEditFormatterFactory({
+      isEditing: additionalData => this.isEditing(additionalData),
+      renderValue: (value, additionalData) => {
+        let prettyValue = value;
+        if (additionalData.property == 'hostgroup') {
+          prettyValue = hostgroups[value];
+        }
+        else if (additionalData.property == 'ansibleGroup') {
+          const ag = this.createAnsibleGroupObject(this.props.ansiblePlaybook.groups);
+          prettyValue = ag[value];
+        }
+        return inlineEditFormatterImpl.renderValue(prettyValue, additionalData)
+      },
+      renderEdit: (value, additionalData) => {
+        if (additionalData.property == 'hostgroup') {
+          if (additionalData.rowData.newEntry === true) {
+            return inlineEditFormatterImpl.renderEditSelect(value, additionalData, hostgroups);
+          }
+          return inlineEditFormatterImpl.renderValue(hostgroups[value], additionalData)
+        }
+        else if (additionalData.property == 'ansibleGroup') {
+          const ag = this.createAnsibleGroupObject(this.props.ansiblePlaybook.groups);
+
+          if (additionalData.rowData.newEntry === true) {
+            return inlineEditFormatterImpl.renderEditSelect(value, additionalData, ag);
+          }
+          return inlineEditFormatterImpl.renderValue(ag[value], additionalData);
+        }
+        return inlineEditFormatterImpl.renderEditText(value, additionalData);
+      }
+    });
+    this.inlineEditFormatter = inlineEditFormatter;
+
+    initApplicationDefinition(
+      ansiblePlaybook,
+      services,
+      ansibleVarsAll,
+      this.headerFormatter,
+      this.inlineEditFormatter,
+      this.inlineEditButtonsFormatter,
+    );
+  };
+
+  render() {
+    const {
+      data: { organization, location, mode, ansiblePlaybooks, foremanDataUrl, ansibleDataUrl },
+      ansiblePlaybook,
+      services,
+      columns,
+      addApplicationDefinitionService,
+      confirmEditApplicationDefinitionService,
+      cancelEditApplicationDefinitionService,
+      closeForemanParameterSelectionModal,
+      openAnsibleParameterSelectionModal,
+      closeAnsibleParameterSelectionModal,
+      ParameterSelectionModal,
+      loadAnsibleData,
+    } = this.props;
+
+    return (
+      <span>
+        <div>
+          <AnsiblePlaybookSelector
+            label="Ansible Playbook"
+            editable={ mode == 'newDefinition' }
+            viewText={ ansiblePlaybook.name }
+            options={ ansiblePlaybooks }
+            onChange={ loadAnsibleData }
+            selectValue={ ansiblePlaybook.id.toString() }
+            additionalData={{url: ansibleDataUrl }}
+          />
+        </div>
+        <div className="form-group">
+          <AddTableEntry
+            hidden={ false }
+            disabled={ this.props.editMode }
+            onAddTableEntry={ addApplicationDefinitionService }
+          />
+          <Table.PfProvider
+            striped
+            bordered
+            hover
+            dataTable
+            inlineEdit
+            columns={columns}
+            components={{
+              body: {
+                row: Table.InlineEditRow,
+                cell: cellProps => cellProps.children
+              }
+            }}
+          >
+            <Table.Header headerRows={resolve.headerRows({ columns })} />
+            <Table.Body
+              rows={services}
+              rowKey="id"
+              onRow={(rowData, { rowIndex }) => ({
+                role: 'row',
+                isEditing: () => this.isEditing({ rowData }),
+                onCancel: () => cancelEditApplicationDefinitionService({ rowData, rowIndex }),
+                onConfirm: () => confirmEditApplicationDefinitionService({ rowData, rowIndex }),
+                last: rowIndex === services.length - 1
+              })}
+            />
+          </Table.PfProvider>
+          <AddTableEntry
+            hidden={ false }
+            disabled={ this.props.editMode }
+            onAddTableEntry={ addApplicationDefinitionService }
+          />
+          <span style={{ marginLeft: 30 }}>
+            Ansible group vars 'all':
+            <Button
+              style={{ marginLeft: 10 }}
+              bsStyle="default"
+              disabled={ this.props.editMode }
+              onClick={() => openAnsibleParameterSelectionModal({
+                isAllGroup: true
+              })}
+            >
+              <span title="change ansible variables for 'all'">A</span>
+            </Button>
+          </span>
+        </div>
+        <div>
+          <ForemanModal
+            id="AppDefinitionForemanParamSelection"
+            dialogClassName="param_selection_modal"
+            title="Foreman Parameter definition for Application Definition"
+          >
+            <ForemanModal.Header closeButton={false}>
+              Parameter definition
+            </ForemanModal.Header>
+            {this.props.parametersData ? (
+              <ParameterSelection
+                paramType={ PARAMETER_SELECTION_PARAM_TYPE_FOREMAN }
+                location={ location }
+                organization={ organization }
+                paramDataUrl= { foremanDataUrl }
+                data={ this.props.parametersData }
+              />
+            ) : (<span>Empty</span>)
+            }
+            <ForemanModal.Footer>
+              <div>
+                <Button bsStyle="primary" onClick={() => closeForemanParameterSelectionModal({ mode: 'save' })}>Save</Button>
+                <Button bsStyle="default" onClick={() => closeForemanParameterSelectionModal({ mode: 'cancel' })}>Cancel</Button>
+              </div>
+            </ForemanModal.Footer>
+          </ForemanModal>
+        </div>
+        <div>
+          <ForemanModal
+            id="AppDefinitionAnsibleParamSelection"
+            dialogClassName="param_selection_modal"
+            title="Ansible variables for Application Definition"
+          >
+            <ForemanModal.Header closeButton={false}>
+              Parameter definition
+            </ForemanModal.Header>
+            {this.props.parametersData ? (
+              <ParameterSelection
+                paramType={ PARAMETER_SELECTION_PARAM_TYPE_ANSIBLE }
+                location={ location }
+                organization={ organization }
+                data={ this.props.parametersData }
+              />
+            ) : (<span>Empty</span>)
+            }
+            <ForemanModal.Footer>
+              <div>
+                <Button bsStyle="primary" onClick={() => closeAnsibleParameterSelectionModal({ mode: 'save' })}>Save</Button>
+                <Button bsStyle="default" onClick={() => closeAnsibleParameterSelectionModal({ mode: 'cancel' })}>Cancel</Button>
+              </div>
+            </ForemanModal.Footer>
+          </ForemanModal>
+        </div>
+        <RailsData
+          key='applications_definition'
+          view='app_definition'
+          parameter='services'
+          value={JSON.stringify(this.props.services)}
+        />
+        <RailsData
+          key='applications_definition'
+          view='app_definition'
+          parameter='ansible_vars_all'
+          value={JSON.stringify(this.props.ansibleVarsAll)}
+        />
+      </span>
+    )};
+}
+
+ApplicationDefinition.defaultProps = {
+  error: {},
+  editMode: false,
+  ansiblePlaybook: { "id": '', "name": '' },
+  services: [],
+  ansibleVarsAll: [],
+  parametersData: {},
+  columns: [],
+  editParamsOfRowId: null,
+}
+
+ApplicationDefinition.propTypes = {
+  initApplicationDefinition: PropTypes.func,
+  editMode: PropTypes.bool.isRequired,
+  ansiblePlaybook: PropTypes.object,
+  services: PropTypes.array,
+  ansibleVarsAll: PropTypes.array,
+  columns: PropTypes.array,
+  addApplicationDefinitionService: PropTypes.func,
+  deleteApplicationDefinitionService: PropTypes.func,
+  activateEditApplicationDefinitionService: PropTypes.func,
+  confirmEditApplicationDefinitionService: PropTypes.func,
+  cancelEditApplicationDefinitionService: PropTypes.func,
+  changeEditApplicationDefinitionService: PropTypes.func,
+  openForemanParameterSelectionModal: PropTypes.func,
+  closeForemanParameterSelectionModal: PropTypes.func,
+  openAnsibleParameterSelectionModal: PropTypes.func,
+  closeAnsibleParameterSelectionModal: PropTypes.func,
+  parametersData: PropTypes.object,
+};
+
+export default ApplicationDefinition;