};
};
+ enableGithubProvisioning = () => {
+ this.scimStatus = false;
+ this.githubProvisioningStatus = true;
+ };
+
handleActivateScim = () => {
this.scimStatus = true;
return Promise.resolve();
const definition = this.#definitions.find(
(d) => d.key === data.keys
) as ExtendedSettingDefinition;
- if (definition.type === SettingType.PROPERTY_SET) {
+ if (data.keys === 'sonar.auth.github.userConsentForPermissionProvisioningRequired') {
+ this.#settingValues = this.#settingValues.filter(
+ (s) => s.key !== 'sonar.auth.github.userConsentForPermissionProvisioningRequired'
+ );
+ } else if (definition.type === SettingType.PROPERTY_SET) {
setting.fieldValues = [];
} else if (definition.multiValues === true) {
setting.values = definition.defaultValue?.split(',') ?? [];
this.#secretKeyAvailable = val;
};
+ presetGithubAutoProvisioning = () => {
+ this.set('sonar.auth.github.enabled', 'true');
+ this.set('sonar.auth.github.clientId.secured', 'client ID');
+ this.set('sonar.auth.github.clientSecret.secured', 'shut');
+ this.set('sonar.auth.github.appId', 'Appid');
+ this.set('sonar.auth.github.privateKey.secured', 'private key');
+ this.set('sonar.auth.github.apiUrl', 'API url');
+ this.set('sonar.auth.github.webUrl', 'web URL');
+ };
+
reset = () => {
this.#settingValues = cloneDeep(this.#defaultValues);
this.#definitions = cloneDeep(DEFAULT_DEFINITIONS_MOCK);
{tab.key === AlmKeys.GitHub && (
<GithubAuthenticationTab
+ currentTab={currentTab}
definitions={definitions.filter((def) => def.subCategory === AlmKeys.GitHub)}
/>
)}
--- /dev/null
+/*
+ * SonarQube
+ * Copyright (C) 2009-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import * as React from 'react';
+import { FormattedMessage } from 'react-intl';
+import DocLink from '../../../../components/common/DocLink';
+import Modal from '../../../../components/controls/Modal';
+import { Button } from '../../../../components/controls/buttons';
+import { translate } from '../../../../helpers/l10n';
+import { useToggleGithubProvisioningMutation } from '../../../../queries/identity-provider';
+import { useGetValueQuery, useResetSettingsMutation } from '../../../../queries/settings';
+
+const GITHUB_PERMISSION_USER_CONSENT =
+ 'sonar.auth.github.userConsentForPermissionProvisioningRequired';
+
+export default function AutoProvisioningConsent() {
+ const toggleGithubProvisioning = useToggleGithubProvisioningMutation();
+ const resetSettingsMutation = useResetSettingsMutation();
+ const { data } = useGetValueQuery(GITHUB_PERMISSION_USER_CONSENT);
+
+ const header = translate('settings.authentication.github.confirm_auto_provisioning.header');
+
+ const removeConsentFlag = () => {
+ resetSettingsMutation.mutate([GITHUB_PERMISSION_USER_CONSENT]);
+ };
+
+ const switchToJIT = async () => {
+ await toggleGithubProvisioning.mutateAsync(false);
+ removeConsentFlag();
+ };
+
+ const continueWithAuto = async () => {
+ await toggleGithubProvisioning.mutateAsync(true);
+ removeConsentFlag();
+ };
+
+ if (data?.value !== '') {
+ return null;
+ }
+
+ return (
+ <Modal contentLabel={header} shouldCloseOnOverlayClick={false} size="medium">
+ <header className="modal-head">
+ <h2>{header}</h2>
+ </header>
+ <div className="modal-body">
+ <FormattedMessage
+ tagName="p"
+ id="settings.authentication.github.confirm_auto_provisioning.description1"
+ />
+ <FormattedMessage
+ id="settings.authentication.github.confirm_auto_provisioning.description2"
+ tagName="p"
+ values={{
+ documentation: (
+ <DocLink to="/instance-administration/authentication/github/">
+ <FormattedMessage id="documentation" />
+ </DocLink>
+ ),
+ }}
+ />
+ <FormattedMessage
+ tagName="p"
+ id="settings.authentication.github.confirm_auto_provisioning.question"
+ />
+ </div>
+ <footer className="modal-foot">
+ <Button onClick={continueWithAuto}>
+ {translate('settings.authentication.github.confirm_auto_provisioning.continue')}
+ </Button>
+ <Button onClick={switchToJIT}>
+ {translate('settings.authentication.github.confirm_auto_provisioning.switch_jit')}
+ </Button>
+ </footer>
+ </Modal>
+ );
+}
} from '../../../../queries/identity-provider';
import { AlmKeys } from '../../../../types/alm-settings';
import { ExtendedSettingDefinition } from '../../../../types/settings';
-import { DOCUMENTATION_LINK_SUFFIXES } from './Authentication';
+import { AuthenticationTabs, DOCUMENTATION_LINK_SUFFIXES } from './Authentication';
import AuthenticationFormField from './AuthenticationFormField';
+import AutoProvisioningConsent from './AutoProvisionningConsent';
import ConfigurationForm from './ConfigurationForm';
import GitHubConfigurationValidity from './GitHubConfigurationValidity';
import useGithubConfiguration, { GITHUB_JIT_FIELDS } from './hook/useGithubConfiguration';
interface GithubAuthenticationProps {
definitions: ExtendedSettingDefinition[];
+ currentTab: AuthenticationTabs;
}
const GITHUB_EXCLUDED_FIELD = [
];
export default function GithubAuthenticationTab(props: GithubAuthenticationProps) {
- const { definitions } = props;
+ const { definitions, currentTab } = props;
const { data } = useIdentityProviderQuery();
const [showEditModal, setShowEditModal] = useState(false);
const [showConfirmProvisioningModal, setShowConfirmProvisioningModal] = useState(false);
hasLegacyConfiguration={hasLegacyConfiguration}
/>
)}
+
+ {currentTab === AlmKeys.GitHub && <AutoProvisioningConsent />}
</div>
);
}
configDetailsDialog: byRole('dialog', {
name: 'settings.authentication.github.configuration.validation.details.title',
}),
+ continueAutoButton: byRole('button', {
+ name: 'settings.authentication.github.confirm_auto_provisioning.continue',
+ }),
+ switchJitButton: byRole('button', {
+ name: 'settings.authentication.github.confirm_auto_provisioning.switch_jit',
+ }),
+ consentDialog: byRole('dialog', {
+ name: 'settings.authentication.github.confirm_auto_provisioning.header',
+ }),
getConfigDetailsTitle: () => within(ui.github.configDetailsDialog.get()).getByRole('heading'),
getOrgs: () => within(ui.github.configDetailsDialog.get()).getAllByRole('listitem'),
fillForm: async (user: UserEvent) => {
expect(await github.syncWarning.find()).toBeInTheDocument();
expect(github.syncSummary.get()).toBeInTheDocument();
});
+
+ it('should display a modal if user was already using auto and continue using auto provisioning', async () => {
+ const user = userEvent.setup();
+ settingsHandler.presetGithubAutoProvisioning();
+ handler.enableGithubProvisioning();
+ settingsHandler.set('sonar.auth.github.userConsentForPermissionProvisioningRequired', '');
+ renderAuthentication([Feature.GithubProvisioning]);
+
+ await user.click(await github.tab.find());
+
+ expect(await github.consentDialog.find()).toBeInTheDocument();
+ await user.click(github.continueAutoButton.get());
+
+ expect(await github.githubProvisioningButton.find()).toBeChecked();
+ expect(github.consentDialog.query()).not.toBeInTheDocument();
+ });
+
+ it('should display a modal if user was already using auto and switch to JIT', async () => {
+ const user = userEvent.setup();
+ settingsHandler.presetGithubAutoProvisioning();
+ handler.enableGithubProvisioning();
+ settingsHandler.set('sonar.auth.github.userConsentForPermissionProvisioningRequired', '');
+ renderAuthentication([Feature.GithubProvisioning]);
+
+ await user.click(await github.tab.find());
+
+ expect(await github.consentDialog.find()).toBeInTheDocument();
+ await user.click(github.switchJitButton.get());
+
+ expect(await github.jitProvisioningButton.find()).toBeChecked();
+ expect(github.consentDialog.query()).not.toBeInTheDocument();
+ });
});
});
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
-import { getValues, resetSettingValue, setSettingValue } from '../api/settings';
+import { getValue, getValues, resetSettingValue, setSettingValue } from '../api/settings';
import { ExtendedSettingDefinition } from '../types/settings';
type SettingValue = string | boolean | string[];
});
}
+export function useGetValueQuery(key: string) {
+ return useQuery(['settings', 'details', key] as const, ({ queryKey: [_a, _b, key] }) => {
+ return getValue({ key }).then((v) => v ?? null);
+ });
+}
+
export function useResetSettingsMutation() {
const queryClient = useQueryClient();
return useMutation({
settings.authentication.github.confirm.jit=Switch to Just-in-Time provisioning
settings.authentication.github.confirm.auto.description=Once you transition to automatic provisioning, groups, users, group memberships, and permissions on GitHub projects will be inherited from GitHub. You will no longer have the ability to edit them within SonarQube. Do you want to proceed with this change?
settings.authentication.github.confirm.jit.description=Switching to Just-in-Time provisioning removes the automatic synchronization of users, groups, and group memberships. Users are provisioned and group memberships are updated only at user login. Are you sure?
+settings.authentication.github.confirm_auto_provisioning.header=Confirm the provisioning method
+settings.authentication.github.confirm_auto_provisioning.description1=Automatic user and group provisioning is currently suspended.
+settings.authentication.github.confirm_auto_provisioning.description2=This provisioning method has been enhanced. It now includes the synchronization of user permissions and project visibility from GitHub. For more details, please refer to the {documentation}.
+settings.authentication.github.confirm_auto_provisioning.question=Which provisioning method would you like to use?
+settings.authentication.github.confirm_auto_provisioning.continue=Automatic user, group, and permission provisioning
+settings.authentication.github.confirm_auto_provisioning.switch_jit=Just-in-Time user and group provisioning
settings.authentication.github.configuration=GitHub Configuration
settings.authentication.github.form.not_configured=GitHub App is not configured
settings.authentication.github.form.legacy_configured=Compatibility with GitHub OAuth App is deprecated and will be removed in a future release. Your configuration will continue to work but with limited support. We recommend using GitHub Apps. Check out the {documentation} for more information.
projects / sonarqube.git / commitdiff