[JENKINS-18938] COPYARTIFACT_BUILD_NUMBER_ does not preserve numbers in job names - Jenkins Jira

XML

Word

Printable

Details

Type: Bug
Status: Closed (View Workflow)
Priority: Blocker
Resolution: Fixed
Component/s: copyartifact-plugin
Labels:
None
Environment:
Linux

Similar Issues:

Show

Description

The COPYARTIFACT_BUIL_NUMBER_ variable name does not preserve numbers in job names. It removes numbers from job names. For example, if the job is called martin-test1, then the variable name name is: COPYARTIFACT_BUILD_NUMBER_MARTIN_TEST_ (the number has been removed)

To reproduce:

create a job whose name has a number in it, e.g. martin-test1
run the job once to create some artifacts, and archive them
create another job whose purpose is to copy the artifacts from the first job
in the build phase of the second job, print the environment variables, e.g. with env, and examine the COPYARTIFACT_BUILD_NUMBER_ variable name. It should be missing the numbers

This was tested in Jenkins 1.524, with version 1.27 of the Copy Artifacts plugin.

Attachments

Issue Links

is related to

JENKINS-15764 Name of COPYARTIFACT_BUILD_NUMER_ variable is incorrectly documented

Closed

JENKINS-29812 Need an Environment variable with multiple build numbers when copying multiple artifacts from different builds of the same project

Closed

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Johanns Gregorian added a comment - 2015-04-21 19:16

This issue is nearly (2) years old, unassigned and without comments.

I don't know and cannot imagine the technical issue that lead the developers to elect to remove numbers from the name; but the fix is trivial for anyone brave enough to patch and build the plugin from scratch (see below).

Anyone in the know, please let me know why numbers are removed.

diff --git a/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java b/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
index 68d0671..4f976ad 100644
--- a/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
+++ b/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
@@ -600,7 +600,7 @@ public class CopyArtifact extends Builder implements SimpleBuildStep {
                 return;
             }
             data.put("COPYARTIFACT_BUILD_NUMBER_"
-                       + projectName.toUpperCase().replaceAll("[^A-Z]+", "_"), // Only use letters and _
+                       + projectName.toUpperCase().replaceAll("[^A-Z0-9]+", "_"), // Only use alphanumeric and _
                      Integer.toString(buildNumber));
         }

Show

Johanns Gregorian added a comment - 2015-04-21 19:16 This issue is nearly (2) years old, unassigned and without comments. I don't know and cannot imagine the technical issue that lead the developers to elect to remove numbers from the name; but the fix is trivial for anyone brave enough to patch and build the plugin from scratch (see below). Anyone in the know, please let me know why numbers are removed. diff --git a/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java b/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java index 68d0671..4f976ad 100644 --- a/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java +++ b/src/main/java/hudson/plugins/copyartifact/CopyArtifact.java @@ -600,7 +600,7 @@ public class CopyArtifact extends Builder implements SimpleBuildStep { return ; } data.put( "COPYARTIFACT_BUILD_NUMBER_" - + projectName.toUpperCase().replaceAll( "[^A-Z]+" , "_" ), // Only use letters and _ + + projectName.toUpperCase().replaceAll( "[^A-Z0-9]+" , "_" ), // Only use alphanumeric and _ Integer .toString(buildNumber)); }

Hide

Permalink

Josh Davidson added a comment - 2015-05-10 00:02

I'm assuming the numbers are removed because on some systems, environment variables cannot start with a number. However, the implementation creates difficult to workaround aliasing problems where job names like my_build_win32 and my_build_win64 resolve to same variable (my_build_win_).

A better implementation that only removes numbers from the start of the variable would be:

projectName.toUpperCase().replaceAll("^[^A-Z]+", "_").replaceAll("[^A-Z0-9]+", "_") // Variables must begin with a letter (or underscore) and consist of letters, numbers, and _

This prevents invalid variables and should avoid aliasing for 99.5% of job names.

Show

Josh Davidson added a comment - 2015-05-10 00:02 I'm assuming the numbers are removed because on some systems, environment variables cannot start with a number. However, the implementation creates difficult to workaround aliasing problems where job names like my_build_win32 and my_build_win64 resolve to same variable (my_build_win_). A better implementation that only removes numbers from the start of the variable would be: projectName.toUpperCase().replaceAll( "^[^A-Z]+" , "_" ).replaceAll( "[^A-Z0-9]+" , "_" ) // Variables must begin with a letter (or underscore) and consist of letters, numbers, and _ This prevents invalid variables and should avoid aliasing for 99.5% of job names.

Hide

Permalink

Josh Davidson added a comment - 2015-05-10 02:49

Scratch that. The only time project name is added to an environment variable is when it's appended to a fixed string (COPYARTIFACT_BUILD_NUMBER_), which avoids the problem of starting with a number altogether. So I agree with Johanns, there's no reason to replace numbers.

Show

Josh Davidson added a comment - 2015-05-10 02:49 Scratch that. The only time project name is added to an environment variable is when it's appended to a fixed string (COPYARTIFACT_BUILD_NUMBER_), which avoids the problem of starting with a number altogether. So I agree with Johanns, there's no reason to replace numbers.

Hide

Permalink

Daniel Beck added a comment - 2015-06-08 08:46

Any change in this will be a breaking change, unfortunately, so it's not as easy as just changing the regex.

Show

Daniel Beck added a comment - 2015-06-08 08:46 Any change in this will be a breaking change, unfortunately, so it's not as easy as just changing the regex.

Hide

Permalink

Daniel Beck added a comment - 2015-06-08 20:30

What could be done (besides what ikedam suggested in the PR which is actually my favorite option: Define your own env var name), is to define multiple variables. Keep the existing one for backwards compatibility, and also define the one with digits in it.

Show

Daniel Beck added a comment - 2015-06-08 20:30 What could be done (besides what ikedam suggested in the PR which is actually my favorite option: Define your own env var name), is to define multiple variables. Keep the existing one for backwards compatibility, and also define the one with digits in it.

Hide

Permalink

ikedam added a comment - 2015-08-11 00:34

Created a pull request: https://github.com/jenkinsci/copyartifact-plugin/pull/69
It introduce a field to specify the suffix to be used instead of the project name.
Leaving empty have the project name used jest as the current brhavior to keep the backward compatibility.

Show

ikedam added a comment - 2015-08-11 00:34 Created a pull request: https://github.com/jenkinsci/copyartifact-plugin/pull/69 It introduce a field to specify the suffix to be used instead of the project name. Leaving empty have the project name used jest as the current brhavior to keep the backward compatibility.

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-09-06 01:36

Code changed in jenkins
User: ikedam
Path:
src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/config.jelly
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix.html
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix_ja.html
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-selector.html
src/test/java/hudson/plugins/copyartifact/CopyArtifactTest.java
src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java
http://jenkins-ci.org/commit/copyartifact-plugin/462bf8f9b7374300e7a8f3b445787fc22d005c4b
Log:
[FIXED JENKINS-18938] Added a field to specify the suffix for the variable to store the build number

Show

SCM/JIRA link daemon added a comment - 2015-09-06 01:36 Code changed in jenkins User: ikedam Path: src/main/java/hudson/plugins/copyartifact/CopyArtifact.java src/main/resources/hudson/plugins/copyartifact/CopyArtifact/config.jelly src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix.html src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix_ja.html src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-selector.html src/test/java/hudson/plugins/copyartifact/CopyArtifactTest.java src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java http://jenkins-ci.org/commit/copyartifact-plugin/462bf8f9b7374300e7a8f3b445787fc22d005c4b Log: [FIXED JENKINS-18938] Added a field to specify the suffix for the variable to store the build number

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-09-06 01:36

Code changed in jenkins
User: ikedam
Path:
src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
src/main/resources/hudson/plugins/copyartifact/Messages.properties
src/test/java/hudson/plugins/copyartifact/CopyArtifactTest.java
http://jenkins-ci.org/commit/copyartifact-plugin/0f3e11465397b556009a111437bc7b742f31daee
Log:
~~JENKINS-18938~~ Added validation for the variable suffix.

Show

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-09-06 01:36

Code changed in jenkins
User: ikedam
Path:
src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java
http://jenkins-ci.org/commit/copyartifact-plugin/250f8a5c09ad702f09a9a77f670e74d4647a7fd5
Log:
~~JENKINS-18938~~ Fixed the test failure caused by a wrong change for test utility in the last two commits.

Show

SCM/JIRA link daemon added a comment - 2015-09-06 01:36 Code changed in jenkins User: ikedam Path: src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java http://jenkins-ci.org/commit/copyartifact-plugin/250f8a5c09ad702f09a9a77f670e74d4647a7fd5 Log: JENKINS-18938 Fixed the test failure caused by a wrong change for test utility in the last two commits.

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-09-06 01:36

Code changed in jenkins
User: ikedam
Path:
src/main/java/hudson/plugins/copyartifact/CopyArtifact.java
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/config.jelly
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix.html
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix_ja.html
src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-selector.html
src/main/resources/hudson/plugins/copyartifact/Messages.properties
src/test/java/hudson/plugins/copyartifact/CopyArtifactTest.java
src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java
http://jenkins-ci.org/commit/copyartifact-plugin/ad631aec628fc881bb9becf4586a58952fc5f59c
Log:
Merge pull request #69 from ikedam/feature/~~JENKINS-18938~~_BuildNumberVariable

~~JENKINS-18938~~ Added a field to specify the suffix for the variable to store the build number

Compare: https://github.com/jenkinsci/copyartifact-plugin/compare/e68ed44754e2...ad631aec628f

Show

SCM/JIRA link daemon added a comment - 2015-09-06 01:36 Code changed in jenkins User: ikedam Path: src/main/java/hudson/plugins/copyartifact/CopyArtifact.java src/main/resources/hudson/plugins/copyartifact/CopyArtifact/config.jelly src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix.html src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-resultVariableSuffix_ja.html src/main/resources/hudson/plugins/copyartifact/CopyArtifact/help-selector.html src/main/resources/hudson/plugins/copyartifact/Messages.properties src/test/java/hudson/plugins/copyartifact/CopyArtifactTest.java src/test/java/hudson/plugins/copyartifact/testutils/CopyArtifactUtil.java http://jenkins-ci.org/commit/copyartifact-plugin/ad631aec628fc881bb9becf4586a58952fc5f59c Log: Merge pull request #69 from ikedam/feature/ JENKINS-18938 _BuildNumberVariable JENKINS-18938 Added a field to specify the suffix for the variable to store the build number Compare: https://github.com/jenkinsci/copyartifact-plugin/compare/e68ed44754e2...ad631aec628f

Hide

Permalink

ikedam added a comment - 2015-09-06 01:57

Fixed in 1.36, which introduced a field to specify the suffix used instead of the project name.
It will be available in the update center in a day.
Please try that.

Show

ikedam added a comment - 2015-09-06 01:57 Fixed in 1.36, which introduced a field to specify the suffix used instead of the project name. It will be available in the update center in a day. Please try that.

People

Assignee:: ikedam

Reporter:: Martin d'Anjou

Votes:: 0 Vote for this issue

Watchers:: 5 Start watching this issue

Dates

Created:: 2013-07-25 21:20

Updated:: 2015-09-06 01:57

Resolved:: 2015-09-06 01:36