opendev/gerrit
Code Issues Proposed changes

Support wildcard matching in repository configuration

Browse Source 
Per repository configuration was only supporting "*" as the repository
name so it was only possible to configure one default submit type and
same owner groups for all the new repositories.

[repository "*"]
  ownerGroup = Registered Users
  defaultSubmitType = MERGE_IF_NECESSARY

Now supports different repository configuration based on the name. The
only matching patterns supported are exact match or wildcard matching
which can be specified by ending the name by a *. Obviously, repository
name "*" still represents all repositories.

If a project matches more than one repository configuration, then the
configuration from the more precise match will be used. In the following
example, the default submit type for a project named project/plugins/a
would be CHERRY_PICK.

[repository "project/*"]
  defaultSubmitType = MERGE_IF_NECESSARY
[repository "project/plugins/*"]
  defaultSubmitType = CHERRY_PICK

Change-Id: I8b9c157f60a3ad1c6f542cef62e5de8fe9333126
This commit is contained in:
Hugo Arès
2014-11-25 15:33:42 -05:00
parent aeb86c3145
commit 7d2b942df7
10 changed files with 282 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
gerrit-server/src/main/java/com/google/gerrit/server/config/GerritGlobalModule.java
View File

@@ -38,7 +38,6 @@ import com.google.gerrit.extensions.webui.FileWebLink;
import com.google.gerrit.extensions.webui.PatchSetWebLink;
import com.google.gerrit.extensions.webui.ProjectWebLink;
import com.google.gerrit.extensions.webui.TopMenu;
import com.google.gerrit.reviewdb.client.AccountGroup;
import com.google.gerrit.rules.PrologModule;
import com.google.gerrit.rules.RulesCache;
import com.google.gerrit.server.AnonymousUser;
@@ -137,7 +136,6 @@ import org.eclipse.jgit.transport.PostReceiveHook;
import org.eclipse.jgit.transport.PreUploadHook;
import java.util.List;
import java.util.Set;
/** Starts global state with standard dependencies. */
@@ -203,9 +201,8 @@ public class GerritGlobalModule extends FactoryModule {
bind(AccountVisibility.class)
.toProvider(AccountVisibilityProvider.class)
.in(SINGLETON);
bind(new TypeLiteral<Set<AccountGroup.UUID>>() {})
.annotatedWith(ProjectOwnerGroups.class)
.toProvider(ProjectOwnerGroupsProvider.class).in(SINGLETON);
factory(ProjectOwnerGroupsProvider.Factory.class);
bind(RepositoryConfig.class);
bind(AuthBackend.class).to(UniversalAuthBackend.class).in(SINGLETON);
DynamicSet.setOf(binder(), AuthBackend.class);

3
gerrit-server/src/main/java/com/google/gerrit/server/config/GitReceivePackGroupsProvider.java
View File

@@ -30,7 +30,8 @@ public class GitReceivePackGroupsProvider extends GroupSetProvider {
@GerritServerConfig Config config,
ThreadLocalRequestContext threadContext,
ServerRequestContext serverCtx) {
super(gb, config, threadContext, serverCtx, "receive", null, "allowGroup");
super(gb, threadContext, serverCtx, config.getStringList("receive", null,
"allowGroup"));
// If no group was set, default to "registered users"
//

3
gerrit-server/src/main/java/com/google/gerrit/server/config/GitUploadPackGroupsProvider.java
View File

@@ -29,7 +29,8 @@ public class GitUploadPackGroupsProvider extends GroupSetProvider {
@GerritServerConfig Config config,
ThreadLocalRequestContext threadContext,
ServerRequestContext serverCtx) {
super(gb, config, threadContext, serverCtx, "upload", null, "allowGroup");
super(gb, threadContext, serverCtx, config.getStringList("upload", null,
"allowGroup"));
// If no group was set, default to "registered users" and "anonymous"
//

6
gerrit-server/src/main/java/com/google/gerrit/server/config/GroupSetProvider.java
View File

@@ -25,7 +25,6 @@ import com.google.gerrit.server.util.ThreadLocalRequestContext;
import com.google.inject.Inject;
import com.google.inject.Provider;
import org.eclipse.jgit.lib.Config;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -40,13 +39,10 @@ public abstract class GroupSetProvider implements
@Inject
protected GroupSetProvider(GroupBackend groupBackend,
@GerritServerConfig Config config,
ThreadLocalRequestContext threadContext,
ServerRequestContext serverCtx, String section,
String subsection, String name) {
ServerRequestContext serverCtx, String[] groupNames) {
RequestContext ctx = threadContext.setContext(serverCtx);
try {
String[] groupNames = config.getStringList(section, subsection, name);
ImmutableSet.Builder<AccountGroup.UUID> builder = ImmutableSet.builder();
for (String n : groupNames) {
GroupReference g = GroupBackends.findBestSuggestion(groupBackend, n);

30
gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectOwnerGroups.java
View File

@@ -1,30 +0,0 @@
// Copyright (C) 2010 The Android Open Source Project
//
// Licensed 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.google.gerrit.server.config;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import com.google.inject.BindingAnnotation;
import java.lang.annotation.Retention;
/**
* Marker on a {@code Set&lt;AccountGroup.Id>} for the configured groups which
* should become owners of a created project.
*/
@Retention(RUNTIME)
@BindingAnnotation
public @interface ProjectOwnerGroups {
}

27
gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectOwnerGroupsProvider.java
View File

@@ -14,30 +14,37 @@
package com.google.gerrit.server.config;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.account.GroupBackend;
import com.google.gerrit.server.util.ServerRequestContext;
import com.google.gerrit.server.util.ThreadLocalRequestContext;
import com.google.inject.Inject;
import org.eclipse.jgit.lib.Config;
import com.google.inject.assistedinject.Assisted;
import com.google.inject.assistedinject.AssistedInject;
/**
* Provider of the group(s) which should become owners of a newly created
* project. Currently only supports {@code ownerGroup} declarations in the
* {@code "*"} repository, like so:
* project. The only matching patterns supported are exact match or wildcard
* matching which can be specified by ending the name with a {@code *}.
*
* <pre>
* [repository &quot;*&quot;]
* ownerGroup = Registered Users
* ownerGroup = Administrators
* [repository &quot;project/*&quot;]
* ownerGroup = Administrators
* </pre>
*/
public class ProjectOwnerGroupsProvider extends GroupSetProvider {
@Inject
public interface Factory {
public ProjectOwnerGroupsProvider create(Project.NameKey project);
}
@AssistedInject
public ProjectOwnerGroupsProvider(GroupBackend gb,
@GerritServerConfig final Config config,
ThreadLocalRequestContext context,
ServerRequestContext serverCtx) {
super(gb, config, context, serverCtx, "repository", "*", "ownerGroup");
ThreadLocalRequestContext context, ServerRequestContext serverCtx,
RepositoryConfig repositoryCfg,
@Assisted Project.NameKey project) {
super(gb, context, serverCtx, repositoryCfg.getOwnerGroups(project));
}
}

85
gerrit-server/src/main/java/com/google/gerrit/server/config/RepositoryConfig.java Normal file
View File

@@ -0,0 +1,85 @@
// Copyright (C) 2014 The Android Open Source Project
//
// Licensed 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.google.gerrit.server.config;
import com.google.gerrit.extensions.client.SubmitType;
import com.google.gerrit.reviewdb.client.Project;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import org.eclipse.jgit.lib.Config;
@Singleton
public class RepositoryConfig {
static final String SECTION_NAME = "repository";
static final String OWNER_GROUP_NAME = "ownerGroup";
static final String DEFAULT_SUBMIT_TYPE_NAME = "defaultSubmitType";
private final Config cfg;
@Inject
public RepositoryConfig(@GerritServerConfig Config cfg) {
this.cfg = cfg;
}
public SubmitType getDefaultSubmitType(Project.NameKey project) {
return cfg.getEnum(SECTION_NAME, findSubSection(project.get()),
DEFAULT_SUBMIT_TYPE_NAME, SubmitType.MERGE_IF_NECESSARY);
}
public String[] getOwnerGroups(Project.NameKey project) {
return cfg.getStringList(SECTION_NAME, findSubSection(project.get()),
OWNER_GROUP_NAME);
}
/**
* Find the subSection to get repository configuration from.
* <p>
* SubSection can use the * pattern so if project name matches more than one
* section, return the more precise one. E.g if the following subSections are
* defined:
*
* <pre>
* [repository "somePath/*"]
* name = value
* [repository "somePath/somePath/*"]
* name = value
* </pre>
*
* and this method is called with "somePath/somePath/someProject" as project
* name, it will return the subSection "somePath/somePath/*"
*
* @param project Name of the project
* @return the name of the subSection, null if none is found
*/
private String findSubSection(String project) {
String subSectionFound = null;
for (String subSection : cfg.getSubsections(SECTION_NAME)) {
if (isMatch(subSection, project)
&& (subSectionFound == null || subSectionFound.length() < subSection
.length())) {
subSectionFound = subSection;
}
}
return subSectionFound;
}
private boolean isMatch(String subSection, String project) {
return project.equals(subSection)
|| (subSection.endsWith("*") && project.startsWith(subSection
.substring(0, subSection.length() - 1)));
}
}