-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #76 from blackducksoftware/assigning-users-to-proj…
…ects Assigning users to the mapped projects
- Loading branch information
Showing
6 changed files
with
298 additions
and
1 deletion.
There are no files selected for viewing
166 changes: 166 additions & 0 deletions
166
src/main/java/com/blackducksoftware/integration/jira/common/BlackDuckAssignUtil.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| /** | ||
| * Black Duck JIRA Plugin | ||
| * | ||
| * Copyright (C) 2019 Black Duck Software, Inc. | ||
| * http://www.blackducksoftware.com/ | ||
| * | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package com.blackducksoftware.integration.jira.common; | ||
|
|
||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.function.Function; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import com.blackducksoftware.integration.jira.common.blackduck.BlackDuckConnectionHelper; | ||
| import com.blackducksoftware.integration.jira.common.model.BlackDuckProjectMapping; | ||
| import com.blackducksoftware.integration.jira.common.settings.GlobalConfigurationAccessor; | ||
| import com.blackducksoftware.integration.jira.common.settings.PluginErrorAccessor; | ||
| import com.blackducksoftware.integration.jira.common.settings.model.PluginBlackDuckServerConfigModel; | ||
| import com.blackducksoftware.integration.jira.config.model.BlackDuckJiraConfigSerializable; | ||
| import com.synopsys.integration.blackduck.api.generated.component.AssignedUserRequest; | ||
| import com.synopsys.integration.blackduck.api.generated.discovery.ApiDiscovery; | ||
| import com.synopsys.integration.blackduck.api.generated.response.AssignedProjectView; | ||
| import com.synopsys.integration.blackduck.api.generated.view.ProjectView; | ||
| import com.synopsys.integration.blackduck.api.generated.view.UserView; | ||
| import com.synopsys.integration.blackduck.service.BlackDuckService; | ||
| import com.synopsys.integration.blackduck.service.BlackDuckServicesFactory; | ||
| import com.synopsys.integration.exception.IntegrationException; | ||
|
|
||
| //TODO remove this when Super users in Black Duck no longer need to be assigned to a project in order to receive notifications for that project. Remove when all customers update to the fixed version of BD | ||
| public class BlackDuckAssignUtil { | ||
| private final BlackDuckJiraLogger logger = new BlackDuckJiraLogger(Logger.getLogger(this.getClass().getName())); | ||
|
|
||
| public void assignUserToBlackDuckProject(final PluginErrorAccessor pluginErrorAccessor, final GlobalConfigurationAccessor globalConfigurationAccessor) { | ||
| try { | ||
| final Set<BlackDuckProjectMapping> blackDuckProjectMappings = getBlackDuckProjectMappings(globalConfigurationAccessor); | ||
| if (blackDuckProjectMappings.isEmpty()) { | ||
| return; | ||
| } | ||
| final BlackDuckService blackDuckService = getBlackDuckService(globalConfigurationAccessor); | ||
| final List<ProjectView> allProjects = getAllBDProjects(blackDuckService); | ||
| final Set<ProjectView> matchingProjects = getMatchingBDProjects(blackDuckProjectMappings, allProjects); | ||
| if (matchingProjects.isEmpty()) { | ||
| return; | ||
| } | ||
| final UserView currentUser = getCurrentUser(blackDuckService); | ||
| final Set<ProjectView> nonAssignedProjects = getProjectsThatNeedAssigning(blackDuckService, currentUser, matchingProjects); | ||
| if (nonAssignedProjects.isEmpty()) { | ||
| return; | ||
| } | ||
| assignUserToProjects(pluginErrorAccessor, blackDuckService, currentUser, nonAssignedProjects); | ||
| } catch (final IntegrationException e) { | ||
| logger.error("Could not assign the Black Duck user to the configured Black Duck projects. " + e.getMessage(), e); | ||
| pluginErrorAccessor.addBlackDuckError(e, "assignUserToBlackDuckProject"); | ||
| } | ||
| } | ||
|
|
||
| public Set<BlackDuckProjectMapping> getBlackDuckProjectMappings(final GlobalConfigurationAccessor globalConfigurationAccessor) { | ||
| if (null == globalConfigurationAccessor.getIssueCreationConfig() && null == globalConfigurationAccessor.getIssueCreationConfig().getProjectMapping()) { | ||
| logger.debug("There is no issue creation configuration or project mappings. Skipping assigning the user to the BD Project."); | ||
| return new HashSet<>(); | ||
| } | ||
| final String projectMappingJson = globalConfigurationAccessor.getIssueCreationConfig().getProjectMapping().getMappingsJson(); | ||
| if (StringUtils.isBlank(projectMappingJson)) { | ||
| logger.debug("There are no project mappings. Skipping assigning the user to the BD Project."); | ||
| return new HashSet<>(); | ||
| } | ||
| final BlackDuckJiraConfigSerializable config = new BlackDuckJiraConfigSerializable(); | ||
| config.setHubProjectMappingsJson(projectMappingJson); | ||
| if (config.getHubProjectMappings().isEmpty()) { | ||
| logger.debug("There are no project mappings in the mapping json. Skipping assigning the user to the BD Project."); | ||
| } | ||
| return config.getHubProjectMappings(); | ||
| } | ||
|
|
||
| public BlackDuckService getBlackDuckService(final GlobalConfigurationAccessor globalConfigurationAccessor) throws IntegrationException { | ||
| final BlackDuckConnectionHelper blackDuckConnectionHelper = new BlackDuckConnectionHelper(); | ||
|
|
||
| final PluginBlackDuckServerConfigModel blackDuckServerConfig = globalConfigurationAccessor.getBlackDuckServerConfig(); | ||
| final BlackDuckServicesFactory blackDuckServicesFactory = blackDuckConnectionHelper.createBlackDuckServicesFactory(logger, blackDuckServerConfig.createBlackDuckServerConfigBuilder()); | ||
|
|
||
| return blackDuckServicesFactory.createBlackDuckService(); | ||
| } | ||
|
|
||
| public List<ProjectView> getAllBDProjects(final BlackDuckService blackDuckService) throws IntegrationException { | ||
| return blackDuckService.getAllResponses(ApiDiscovery.PROJECTS_LINK_RESPONSE); | ||
| } | ||
|
|
||
| public Set<ProjectView> getMatchingBDProjects(final Set<BlackDuckProjectMapping> projectMappings, final List<ProjectView> allProjects) throws IntegrationException { | ||
| final Map<String, ProjectView> projectMap = allProjects.stream().collect(Collectors.toMap(ProjectView::getName, Function.identity())); | ||
|
|
||
| final Set<ProjectView> matchingProjects = new HashSet<>(); | ||
| for (final BlackDuckProjectMapping blackDuckProjectMapping : projectMappings) { | ||
| final String blackDuckProjectName = blackDuckProjectMapping.getBlackDuckProjectName(); | ||
| if (blackDuckProjectMapping.isProjectPattern()) { | ||
| matchingProjects.addAll(projectMap.entrySet().stream() | ||
| .filter(entry -> entry.getKey().matches(blackDuckProjectName)) | ||
| .map(Map.Entry::getValue) | ||
| .collect(Collectors.toSet())); | ||
| } else { | ||
| final ProjectView projectView = projectMap.get(blackDuckProjectName); | ||
| matchingProjects.add(projectView); | ||
| } | ||
| } | ||
| if (matchingProjects.isEmpty()) { | ||
| logger.debug("There are no BD projects that map the projects configured in the project mappings. Skipping assigning the user to the BD Project."); | ||
| } | ||
| return matchingProjects; | ||
| } | ||
|
|
||
| public UserView getCurrentUser(final BlackDuckService blackDuckService) throws IntegrationException { | ||
| return blackDuckService.getResponse(ApiDiscovery.CURRENT_USER_LINK_RESPONSE); | ||
| } | ||
|
|
||
| public Set<ProjectView> getProjectsThatNeedAssigning(final BlackDuckService blackDuckService, final UserView currentUser, final Set<ProjectView> matchingProjects) throws IntegrationException { | ||
| final Set<String> assignedProjects = blackDuckService.getAllResponses(currentUser, UserView.PROJECTS_LINK_RESPONSE) | ||
| .stream() | ||
| .map(AssignedProjectView::getName) | ||
| .collect(Collectors.toSet()); | ||
| final Set<ProjectView> nonAssignedProjects = matchingProjects.stream() | ||
| .filter(project -> !assignedProjects.contains(project.getName())) | ||
| .collect(Collectors.toSet()); | ||
|
|
||
| if (nonAssignedProjects.isEmpty()) { | ||
| logger.debug("There are no BD projects that need to have this User assigned to them. Skipping assigning the user to the BD Project."); | ||
| } | ||
| return nonAssignedProjects; | ||
| } | ||
|
|
||
| public void assignUserToProjects(final PluginErrorAccessor pluginErrorAccessor, final BlackDuckService blackDuckService, final UserView currentUser, final Set<ProjectView> projectsToAssign) throws IntegrationException { | ||
| final AssignedUserRequest assignedUserRequest = new AssignedUserRequest(); | ||
| assignedUserRequest.setUser(currentUser.getHref().orElseThrow(() -> new IntegrationException(String.format("The current user, %s, does not have an href.", currentUser.getUserName())))); | ||
| for (final ProjectView projectView : projectsToAssign) { | ||
| final Optional<String> projectUsersLinkOptional = projectView.getFirstLink(ProjectView.USERS_LINK); | ||
| if (projectUsersLinkOptional.isPresent()) { | ||
| blackDuckService.post(projectUsersLinkOptional.get(), assignedUserRequest); | ||
| } else { | ||
| final String errorMessage = String.format("Could not assign the user, %s, to the project %s because there is no users link.", currentUser.getUserName(), projectView.getName()); | ||
| logger.error(errorMessage); | ||
| pluginErrorAccessor.addBlackDuckError(errorMessage, "assignUserToBlackDuckProject"); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
...ava/com/blackducksoftware/integration/jira/config/controller/action/UserAssignThread.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /** | ||
| * Black Duck JIRA Plugin | ||
| * | ||
| * Copyright (C) 2019 Black Duck Software, Inc. | ||
| * http://www.blackducksoftware.com/ | ||
| * | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package com.blackducksoftware.integration.jira.config.controller.action; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.Timer; | ||
| import java.util.TimerTask; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| import com.blackducksoftware.integration.jira.common.BlackDuckAssignUtil; | ||
| import com.blackducksoftware.integration.jira.common.BlackDuckJiraLogger; | ||
| import com.blackducksoftware.integration.jira.common.model.BlackDuckProjectMapping; | ||
| import com.blackducksoftware.integration.jira.common.settings.GlobalConfigurationAccessor; | ||
| import com.blackducksoftware.integration.jira.common.settings.PluginErrorAccessor; | ||
| import com.synopsys.integration.blackduck.api.generated.view.ProjectView; | ||
| import com.synopsys.integration.blackduck.api.generated.view.UserView; | ||
| import com.synopsys.integration.blackduck.service.BlackDuckService; | ||
| import com.synopsys.integration.exception.IntegrationException; | ||
|
|
||
| public class UserAssignThread extends Thread { | ||
| private final BlackDuckJiraLogger logger; | ||
| private final GlobalConfigurationAccessor globalConfigurationAccessor; | ||
| private final PluginErrorAccessor pluginErrorAccessor; | ||
|
|
||
| private transient boolean shouldTimeout; | ||
|
|
||
| public UserAssignThread(final String threadName, final BlackDuckJiraLogger logger, final GlobalConfigurationAccessor globalConfigurationAccessor, final PluginErrorAccessor pluginErrorAccessor) { | ||
| super(threadName); | ||
| this.logger = logger; | ||
| this.globalConfigurationAccessor = globalConfigurationAccessor; | ||
| this.pluginErrorAccessor = pluginErrorAccessor; | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| logger.debug("Starting User Assignment thread"); | ||
| final Timer timer = new Timer(); | ||
| timer.schedule(new TimerTask() { | ||
| @Override | ||
| public void run() { | ||
| shouldTimeout = true; | ||
| } | ||
| }, 600000); | ||
|
|
||
| final BlackDuckAssignUtil blackDuckAssignUtil = new BlackDuckAssignUtil(); | ||
| try { | ||
| final Set<BlackDuckProjectMapping> blackDuckProjectMappings = blackDuckAssignUtil.getBlackDuckProjectMappings(globalConfigurationAccessor); | ||
| if (blackDuckProjectMappings.isEmpty()) { | ||
| return; | ||
| } | ||
| checkShouldInterruptOrTimeout(); | ||
| final BlackDuckService blackDuckService = blackDuckAssignUtil.getBlackDuckService(globalConfigurationAccessor); | ||
| final List<ProjectView> allProjects = blackDuckAssignUtil.getAllBDProjects(blackDuckService); | ||
| checkShouldInterruptOrTimeout(); | ||
| final Set<ProjectView> matchingProjects = blackDuckAssignUtil.getMatchingBDProjects(blackDuckProjectMappings, allProjects); | ||
| if (matchingProjects.isEmpty()) { | ||
| return; | ||
| } | ||
| checkShouldInterruptOrTimeout(); | ||
| final UserView currentUser = blackDuckAssignUtil.getCurrentUser(blackDuckService); | ||
| checkShouldInterruptOrTimeout(); | ||
| final Set<ProjectView> nonAssignedProjects = blackDuckAssignUtil.getProjectsThatNeedAssigning(blackDuckService, currentUser, matchingProjects); | ||
| if (nonAssignedProjects.isEmpty()) { | ||
| return; | ||
| } | ||
| checkShouldInterruptOrTimeout(); | ||
| blackDuckAssignUtil.assignUserToProjects(pluginErrorAccessor, blackDuckService, currentUser, nonAssignedProjects); | ||
| logger.debug("Completed User Assignment"); | ||
| } catch (final IntegrationException e) { | ||
| logger.error("Could not assign the Black Duck user to the configured Black Duck projects. " + e.getMessage(), e); | ||
| pluginErrorAccessor.addBlackDuckError(e, "assignUserToBlackDuckProject"); | ||
| } catch (final InterruptedException e) { | ||
| logger.warn("The user assignment thread was interrupted."); | ||
| } catch (final TimeoutException e) { | ||
| logger.error("The user assignment thread timed out after 10 minutes."); | ||
| } | ||
| } | ||
|
|
||
| private void checkShouldInterruptOrTimeout() throws InterruptedException, TimeoutException { | ||
| if (!Thread.currentThread().isAlive() || Thread.currentThread().isInterrupted()) { | ||
| throw new InterruptedException(); | ||
| } | ||
| if (shouldTimeout) { | ||
| throw new TimeoutException(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters