Skip to content

Option to ignore type in build StatusName #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jetersen merged 3 commits into from
Jun 19, 2023
Merged

Option to ignore type in build StatusName #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9df28c7
added ignoreTypeInStatusName and tests
mifitous Apr 23, 2023
5cb346c
Merge branch 'master' into discard-type-in-full-name
mifitous Jun 15, 2023
bad93b1
modified: src/test/java/io/jenkins/plugins/gitlabbranchsource/help…
mifitous Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/main/java/io/jenkins/plugins/gitlabbranchsource/BuildStatusNameCustomPartTrait.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public class BuildStatusNameCustomPartTrait extends SCMSourceTrait {
private String buildStatusNameCustomPart = "";

private boolean buildStatusNameOverwrite;
private boolean ignoreTypeInStatusName;

/**
* Constructor for stapler.
Expand All @@ -38,12 +39,18 @@ public void setBuildStatusNameOverwrite(@NonNull Boolean buildStatusNameOverwrit
this.buildStatusNameOverwrite = buildStatusNameOverwrite;
}

@DataBoundSetter
public void setIgnoreTypeInStatusName(@NonNull Boolean ignoreTypeInStatusName) {
this.ignoreTypeInStatusName = ignoreTypeInStatusName;
}

@Override
protected void decorateContext(SCMSourceContext<?, ?> context) {
if (context instanceof GitLabSCMSourceContext) {
GitLabSCMSourceContext ctx = (GitLabSCMSourceContext) context;
ctx.withBuildStatusNameCustomPart(getBuildStatusNameCustomPart());
ctx.withBuildStatusNameOverwrite(getBuildStatusNameOverwrite());
ctx.withIgnoreTypeInStatusName(getIgnoreTypeInStatusName());
}
}

Expand All @@ -66,6 +73,15 @@ public boolean getBuildStatusNameOverwrite() {
return buildStatusNameOverwrite;
}

/**
* Getter method for the build status name overwrite
*
* @return build status name overwrite option
*/
public boolean getIgnoreTypeInStatusName() {
return ignoreTypeInStatusName;
}

/**
* Our descriptor.
*/
Expand Down
11 changes: 11 additions & 0 deletions src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabSCMSourceContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ public class GitLabSCMSourceContext extends SCMSourceContext<GitLabSCMSourceCont

private boolean buildStatusNameOverwrite;

private boolean ignoreTypeInStatusName;

private boolean alwaysBuildMROpen = true;

private boolean alwaysBuildMRReOpen = true;
Expand Down Expand Up @@ -189,6 +191,10 @@ public boolean getBuildStatusNameOverwrite() {
return buildStatusNameOverwrite;
}

public boolean getIgnoreTypeInStatusName() {
return ignoreTypeInStatusName;
}

@NonNull
public GitLabSCMSourceContext wantBranches(boolean include) {
wantBranches = wantBranches || include;
Expand Down Expand Up @@ -299,6 +305,11 @@ public final GitLabSCMSourceContext withBuildStatusNameOverwrite(final Boolean b
return this;
}

public final GitLabSCMSourceContext withIgnoreTypeInStatusName(final Boolean ignoreTypeInStatusName) {
this.ignoreTypeInStatusName = ignoreTypeInStatusName;
return this;
}

@NonNull
@Override
public GitLabSCMSourceRequest newRequest(@NonNull SCMSource source, @CheckForNull TaskListener listener) {
Expand Down
21 changes: 18 additions & 3 deletions ...main/java/io/jenkins/plugins/gitlabbranchsource/helpers/GitLabPipelineStatusNotifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,31 @@ static String getStatusName(
+ revision.getClass().getName() + ", append" + type + " to status name");
}

// Some comments regarding this implementation :
// Old code was :
// GITLAB_PIPELINE_STATUS_PREFIX + GITLAB_PIPELINE_STATUS_DELIMITER + (optional:
// pipelinePrefix + GITLAB_PIPELINE_STATUS_DELIMITER) + type
// New implementation:
// 1- BuildStatusNameCustomPart empty : use default
// GITLAB_PIPELINE_STATUS_PREFIX
// 2- else: depending on BuildStatusNameOverwrite : use
// BuildStatusNameCustomPart appended to GITLAB_PIPELINE_STATUS_PREFIX or use it
// as is
// 3- add type only if required (no ignoreTypeInStatusName)

String pipelinePrefix = sourceContext.getBuildStatusNameCustomPart().trim();
if (!pipelinePrefix.isEmpty()) {
pipelinePrefix = envVars.expand(pipelinePrefix) + GITLAB_PIPELINE_STATUS_DELIMITER;
pipelinePrefix = envVars.expand(pipelinePrefix);
if (!sourceContext.getBuildStatusNameOverwrite()) {
pipelinePrefix = GITLAB_PIPELINE_STATUS_PREFIX + GITLAB_PIPELINE_STATUS_DELIMITER + pipelinePrefix;
}
} else {
pipelinePrefix = GITLAB_PIPELINE_STATUS_PREFIX + GITLAB_PIPELINE_STATUS_DELIMITER;
pipelinePrefix = GITLAB_PIPELINE_STATUS_PREFIX;
}
if (!sourceContext.getIgnoreTypeInStatusName()) {
pipelinePrefix = pipelinePrefix + GITLAB_PIPELINE_STATUS_DELIMITER + type;
}
final String statusName = pipelinePrefix + type;
final String statusName = pipelinePrefix;
LOGGER.log(Level.FINEST, () -> "Retrieved status name is: " + statusName);
return statusName;
}
Expand Down
3 changes: 3 additions & 0 deletions ...sources/io/jenkins/plugins/gitlabbranchsource/BuildStatusNameCustomPartTrait/config.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@
<f:entry title="${%Overwrite full name}" field="buildStatusNameOverwrite">
<f:checkbox default="unchecked"/>
</f:entry>
<f:entry title="${%Do not append type in status name}" field="ignoreTypeInStatusName">
Copy link

@cobexer cobexer May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we avoid a double negation here?

<f:checkbox default="unchecked"/>
</f:entry>
</j:jelly>
35 changes: 35 additions & 0 deletions .../java/io/jenkins/plugins/gitlabbranchsource/helpers/GitLabPipelineStatusNotifierTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,41 @@ public void should_set_branch_status_name() {
+ "branch"));
}

@Test
public void should_set_branch_status_name_withBuildStatusNameCustomPart() {
GitLabSCMSourceContext sourceContext = new GitLabSCMSourceContext(null, null);
sourceContext.withBuildStatusNameCustomPart("CUSTOM");
sourceContext.withBuildStatusNameOverwrite(false);

BranchSCMHead head = new BranchSCMHead("head");
SCMRevision revision = new BranchSCMRevision(head, "hash");

String statusName =
GitLabPipelineStatusNotifier.getStatusName(sourceContext, null, revision, new hudson.EnvVars());

assertThat(
statusName,
is(GitLabPipelineStatusNotifier.GITLAB_PIPELINE_STATUS_PREFIX
+ GitLabPipelineStatusNotifier.GITLAB_PIPELINE_STATUS_DELIMITER
+ "CUSTOM"
+ GitLabPipelineStatusNotifier.GITLAB_PIPELINE_STATUS_DELIMITER
+ "branch"));
}

@Test
public void should_set_branch_status_name_withIgnoreTypeInStatusName() {
GitLabSCMSourceContext sourceContext = new GitLabSCMSourceContext(null, null);
sourceContext.withIgnoreTypeInStatusName(true);

BranchSCMHead head = new BranchSCMHead("head");
SCMRevision revision = new BranchSCMRevision(head, "hash");

String statusName =
GitLabPipelineStatusNotifier.getStatusName(sourceContext, null, revision, new hudson.EnvVars());

assertThat(statusName, is(GitLabPipelineStatusNotifier.GITLAB_PIPELINE_STATUS_PREFIX));
}

@Test
public void should_set_merge_request_head_status_name() {
GitLabSCMSourceContext sourceContext = new GitLabSCMSourceContext(null, null);
Expand Down