@@ -10,5 +13,8 @@
<%= link_to(_('Learn more about this in the documentation.'), documentation_url('#4.1ImportingRoles', :root_url => ansible_doc_url), target: '_blank') %>
<%= ansible_proxy_import(hash_for_import_ansible_roles_path) %>
+ <%= vcs_import %>
+
+<%= react_component('VcsCloneModalContent', {:title => "Get Ansible-Roles from VCS"})%>
diff --git a/config/routes.rb b/config/routes.rb
index 1a0431e4f..15ff4a02a 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -32,6 +32,15 @@
post :multiple_play_roles
end
end
+ resources :smart_proxies, :only => [] do
+ member do
+ get 'repository_metadata', to: 'vcs_clone#repository_metadata'
+ get 'roles', to: 'vcs_clone#installed_roles'
+ post 'roles', to: 'vcs_clone#install_role'
+ put 'roles/:role_name', to: 'vcs_clone#update_role', constraints: { role_name: %r{[^\/]+} }
+ delete 'roles/:role_name', to: 'vcs_clone#delete_role', constraints: { role_name: %r{[^\/]+} }
+ end
+ end
end
end
end
diff --git a/lib/foreman_ansible/register.rb b/lib/foreman_ansible/register.rb
index 97e973527..b36a67a94 100644
--- a/lib/foreman_ansible/register.rb
+++ b/lib/foreman_ansible/register.rb
@@ -160,6 +160,8 @@
{ :'api/v2/ansible_inventories' => [:schedule] }
permission :import_ansible_playbooks,
{ :'api/v2/ansible_playbooks' => [:sync, :fetch] }
+ permission :clone_from_vcs,
+ { :'api/v2/vcs_clone' => [:repository_metadata, :installed_roles, :install_role, :update_role, :delete_role] }
end
role 'Ansible Roles Manager',
@@ -170,7 +172,7 @@
:import_ansible_roles, :view_ansible_variables, :view_lookup_values,
:create_lookup_values, :edit_lookup_values, :destroy_lookup_values,
:create_ansible_variables, :import_ansible_variables,
- :edit_ansible_variables, :destroy_ansible_variables, :import_ansible_playbooks]
+ :edit_ansible_variables, :destroy_ansible_variables, :import_ansible_playbooks, :clone_from_vcs]
role 'Ansible Tower Inventory Reader',
[:view_hosts, :view_hostgroups, :view_facts, :generate_report_templates, :generate_ansible_inventory,
diff --git a/test/functional/api/v2/vcs_clone_controller_test.rb b/test/functional/api/v2/vcs_clone_controller_test.rb
new file mode 100644
index 000000000..aae844cc1
--- /dev/null
+++ b/test/functional/api/v2/vcs_clone_controller_test.rb
@@ -0,0 +1,105 @@
+require 'test_plugin_helper'
+
+module Api
+ module V2
+ class VcsCloneControllerTest < ActionController::TestCase
+ describe 'input' do
+ test 'handles missing proxy capability' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+
+ get :repository_metadata,
+ params: { id: proxy.id, vcs_url: 'https://github.com/theforeman/foreman_ansible.git' },
+ session: set_session_user
+
+ response = JSON.parse(@response.body)
+ assert_response :bad_request
+ assert_equal({ 'error' =>
+ { 'message' => 'Smart Proxy is missing foreman_ansible installation or Git cloning capability' } }, response)
+ end
+ end
+ describe '#repo_information' do
+ test 'requests repo information' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+ SmartProxy.any_instance.stubs(:has_capability?).returns(true)
+ ProxyAPI::Ansible.any_instance.expects(:repo_information).returns({
+ 'head' => {},
+ 'branches' => {},
+ 'tags' => {},
+ 'vcs_url' => 'https://github.com/theforeman/foreman_ansible.git'
+ })
+
+ get :repository_metadata,
+ params: { id: proxy.id, vcs_url: 'https://github.com/theforeman/foreman_ansible.git' },
+ session: set_session_user
+
+ response = JSON.parse(@response.body)
+ assert_response :success
+ assert_equal({ 'head' => {},
+ 'branches' => {},
+ 'tags' => {},
+ 'vcs_url' => 'https://github.com/theforeman/foreman_ansible.git' }, response)
+ end
+ end
+ describe '#installed_roles' do
+ test 'requests installed roles' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+ SmartProxy.any_instance.stubs(:has_capability?).returns(true)
+ ProxyAPI::Ansible.any_instance.expects(:list_installed).returns(%w[role1 role2])
+
+ get :installed_roles,
+ params: { id: proxy.id },
+ session: set_session_user
+
+ response = JSON.parse(@response.body)
+ assert_response :success
+ assert_equal(%w[role1 role2], response)
+ end
+ end
+ describe '#install_role' do
+ test 'installes a role' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+ SmartProxy.any_instance.stubs(:has_capability?).returns(true)
+
+ post :install_role,
+ params: { id: proxy.id, repo_info: {
+ 'vcs_url' => 'https://github.com/theforeman/foreman_ansible.git',
+ 'role_name' => 'best.role.ever',
+ 'ref' => 'master'
+ } },
+ session: set_session_user
+ assert_response :success
+ end
+ test 'handles faulty parameters' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+ SmartProxy.any_instance.stubs(:has_capability?).returns(true)
+
+ post :install_role,
+ params: { id: proxy.id, 'repo_info': {
+ 'vcs_urll' => 'https://github.com/theforeman/foreman_ansible.git',
+ 'role_name' => 'best.role.ever',
+ 'ref' => 'master'
+ } },
+ session: set_session_user
+ response = JSON.parse(@response.body)
+ assert_response :bad_request
+ assert_equal({ 'error' => 'param is missing or the value is empty: vcs_url' }, response)
+ end
+ end
+ describe '#update_role' do
+ # With the difference of the http-method being PUT, this is
+ # identical to #install_role
+ end
+ describe '#delete_role' do
+ test 'deletes a role' do
+ proxy = FactoryBot.create(:smart_proxy, :with_ansible)
+ SmartProxy.any_instance.stubs(:has_capability?).returns(true)
+
+ delete :delete_role,
+ params: { id: proxy.id, role_name: 'best.role.ever' },
+ session: set_session_user
+ assert_response :success
+ end
+ end
+ end
+ end
+end
diff --git a/webpack/components/VcsCloneModalContent/VcsCloneModalContent.js b/webpack/components/VcsCloneModalContent/VcsCloneModalContent.js
new file mode 100644
index 000000000..5e416285a
--- /dev/null
+++ b/webpack/components/VcsCloneModalContent/VcsCloneModalContent.js
@@ -0,0 +1,245 @@
+import React, { useState, useEffect, useCallback } from 'react';
+import {
+ Modal,
+ ModalVariant,
+ Button,
+ Grid,
+ GridItem,
+ Alert,
+ Popover,
+} from '@patternfly/react-core';
+import { HelpIcon } from '@patternfly/react-icons';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import { GitLinkInputComponent } from './components/GitLinkInputComponent';
+import { BranchTagSelectionMenu } from './components/BranchTagSelectionMenu';
+import { SmartProxySelector } from './components/SmartProxySelector';
+import { ModalConfirmButton } from './components/ModalConfirmButton';
+import { fetchSmartProxies } from './VcsCloneModalContentHelpers';
+import { RoleNameInput } from './components/RoleNameInput';
+import { UpdateExistingSwitch } from './components/UpdateExistingSwitch';
+
+export const VcsCloneModalContent = () => {
+ const [gitRef, setGitRef] = useState('main');
+ const [installedRoles, setInstalledRoles] = useState({});
+ const [repoName, setRepoName] = useState('');
+ const [isModalButtonLoading, setIsModalButtonLoading] = useState(false);
+ const [isModalOpen, setIsModalOpen] = useState(false);
+ const [repoInfo, setRepoInfo] = useState({
+ branches: {},
+ tags: {},
+ vcs_url: null,
+ });
+ const [branchTagsEnabled, setBranchTagsEnabled] = useState(false);
+ const [alertText, setAlertText] = useState('');
+ const [originalRepoName, setOriginalRepoName] = useState('');
+ const [smartProxies, setSmartProxies] = useState({});
+ const [smartProxySelection, setSmartProxySelection] = useState([]);
+ const [updateExisting, setUpdateExisting] = useState(false);
+ const [isErrorState, setIsErrorState] = useState(false);
+ const [isModalButtonActive, setIsModalButtonActive] = useState(false);
+
+ // EFFECT-HANDLERS
+
+ /**
+ * Watch URL-anchor and open/close modal.
+ */
+ useEffect(() => {
+ // Handle direct link ...#vcs_import
+ if (window.location.hash === '#vcs_download') {
+ handleModalToggle();
+ }
+ // Set event listener for anchor change
+ onhashchange = () => {
+ if (window.location.hash === '#vcs_download') {
+ handleModalToggle();
+ }
+ };
+ }, [handleModalToggle]);
+
+ /**
+ * Fetch SmartProxies when the modal is opened.
+ */
+ useEffect(() => {
+ async function request() {
+ if (isModalOpen) {
+ const smartProxiesRequest = await fetchSmartProxies();
+ if (
+ Object.keys(smartProxiesRequest.proxies).length === 0 ||
+ !smartProxiesRequest.ok
+ ) {
+ setAlertText(
+ __('No smartproxies with support for cloning from Git found')
+ );
+ setIsErrorState(true);
+ } else {
+ setSmartProxies(smartProxiesRequest.proxies);
+ }
+ }
+ }
+
+ // eslint-disable-next-line no-unused-vars
+ const ignored = request();
+ }, [isModalOpen]);
+
+ useEffect(() => {
+ setIsModalButtonActive(
+ !isErrorState &&
+ repoName !== '' &&
+ smartProxySelection.length !== 0 &&
+ gitRef !== ''
+ );
+ }, [isErrorState, repoName, gitRef, smartProxySelection.length]);
+
+ /**
+ * Method to check whether a role is already present on the selected SmartProxy.
+ * Called when one of the deps is updated
+ * Checks whether 'Repo name' is a role that is already present on the selected SmartProxy.
+ * -> Shows the alert if a collision is present.
+ */
+ useEffect(() => {
+ setIsErrorState(false);
+ if (smartProxySelection.length !== 0) {
+ // eslint-disable-next-line no-unused-vars
+ for (const [_, proxyId] of Object.entries(smartProxies)) {
+ const roles = installedRoles[proxyId];
+
+ if (roles !== undefined) {
+ if (roles.has(repoName) && !updateExisting) {
+ setAlertText(
+ sprintf(
+ __(
+ 'A repository with the name %(rName)s is already present on %(pName)s'
+ ),
+ {
+ rName: repoName,
+ pName: Object.keys(smartProxies).filter(
+ key => smartProxies[key] === proxyId
+ ),
+ }
+ )
+ );
+ setIsErrorState(true);
+ }
+ }
+ }
+ }
+ }, [
+ smartProxySelection,
+ repoName,
+ smartProxies,
+ installedRoles,
+ updateExisting,
+ ]);
+
+ // CALLBACKS
+
+ /**
+ * To be called when the modal is to be opened or closed.
+ * Called by: 'Cancel'- and 'x'-button
+ * Resets all the states and toggles modal visibility.
+ */
+ const handleModalToggle = useCallback(() => {
+ if (isModalOpen) {
+ setGitRef('main');
+ setInstalledRoles({});
+ setRepoName('');
+ setIsModalButtonLoading(false);
+ setIsModalButtonActive(false);
+ setIsModalOpen(false);
+ setRepoInfo({
+ branches: {},
+ tags: {},
+ vcs_url: null,
+ });
+ setIsErrorState(false);
+ setAlertText('');
+ setOriginalRepoName('');
+ setSmartProxies({});
+ setSmartProxySelection([]);
+ setUpdateExisting(false);
+ setBranchTagsEnabled(false);
+ window.location.hash = '';
+ }
+ setIsModalOpen(!isModalOpen);
+ }, [isModalOpen]);
+
+ return (
+
+
+ {__('Cancel')}
+ ,
+ ]}
+ help={
+ TODO: Link to Foreman doc }>
+