Unique Names for Regex Patterns #27

pyieh · 2022-04-15T01:42:02Z

Added a Name field to regex patterns as part of the global configurations and forces them to be unique. Allows for human-readable label of regex patterns and makes Admin remote configuration of these patterns easier.

Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

…ws for human-readable label of regex patterns and makes Admin remote configuration of these patterns easier

…asier

… and regex match

ramapalani

LGTM

pyieh · 2022-05-17T01:57:58Z

@oleg-nenashev I'm wondering why the maven-release-plugin didn't cut a new release for the plugin (I had to manually do a release). Looks like there was an error message where the plugin's JAR is missing. Can you take a look and let me know what's missing and needs to be done?

pyieh · 2022-05-24T22:27:52Z

@oleg-nenashev Can we get some help looking into why the maven-release-plugin didn't catch this PR's merge to master and release the plugin like other PR merges? And is there a way to force this?

pyieh · 2022-05-25T21:53:40Z

@jglick Wondering if we can get some help looking into why the maven-release-plugin didn't catch and do a release for our PR merge and is there a way to force that?

jglick · 2022-05-26T12:09:06Z

why the maven-release-plugin didn't cut a new release for the plugin (I had to manually do a release)

Not sure I follow the question. Are you asking about https://www.jenkins.io/doc/developer/publishing/releasing-cd/ which you have not set up for this plugin? Human-oriented version numbers (1.3 etc.) produced manually and on demand via maven-release-plugin (running mvn -B release:prepare release:perform using personal Artifactory & GitHub credentials) is the traditional way of releasing plugins. Maybe you are asking something unrelated.

an error message where the plugin's JAR is missing

Which error message?

Better to use the dev list, and be specific.

Faheetah · 2022-08-17T17:43:59Z

This PR broke the plugin functionality, even using the snippet generator from Jenkins throws java.lang.ClassCastException: java.util.Collections$UnmodifiableMap cannot be cast to java.lang.String

pyieh · 2022-08-17T22:33:25Z

@Faheetah Can you open a ticket with your specific Jenkins configs? We've been running this version in our production Jenkins since its release with no issues.

Faheetah · 2022-08-17T23:07:28Z

@pyieh someone already has one looks like, but no response to it. Do you have a config publicly viewable somewhere maybe the pipeline builder is wrong but I can't figure out how to make it work. Anyway this can move to the issue, I don't have it off hand but it's one of the most recently created

v1v · 2022-08-18T15:07:39Z

I've just found this is a breaking change, with 3.1 the below snippet worked like a charm

wrap([$class: 'MaskPasswordsBuildWrapper', varMaskRegexes: [[regex: 'token:[^,]*']]]) {
  // ...
}

but after upgrading to 3.3, things start failing apart:

15:39:59  [ERROR] Exception: java.lang.IllegalArgumentException: Could not instantiate {delegate={$class=MaskPasswordsBuildWrapper, varMaskRegexes=[{regex=token:[^,]*}]}} for org.jenkinsci.plugins.workflow.steps.CoreWrapperStep: java.lang.IllegalArgumentException: Could not instantiate {varMaskRegexes=[{regex=token:[^,]*}]} for com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper: java.lang.IllegalArgumentException: Could not instantiate {name=null, value=null} for com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsConfig$VarMaskRegexEntry: java.lang.ClassCastException: com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsConfig$VarMaskRegexEntry.value expects class java.lang.String but received class com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper$VarMaskRegex
15:39:59  [Pipeline] error

See this log

And the shared library step -> https://github.com/elastic/apm-pipeline-library/blob/a160e7fff39c0b0368cf63383b86629975ee1905/vars/githubAppToken.groovy#L87

v1v · 2022-08-18T15:25:39Z

If I use the new syntax from the Pipeline syntax:

maskPasswords(varMaskRegexes: [[name: null, value: [$class: 'VarMaskRegex', regex: 'token:[^,]*']]]) {
    // some block
}

It fails with the below stacktrace

16:22:53  ERROR: There were some failures with the notifications
16:22:53  java.lang.ClassCastException: java.util.Collections$UnmodifiableMap cannot be cast to java.lang.String
16:22:53  	at com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsConfig$VarMaskRegexEntry$DescriptorImpl.customInstantiate(MaskPasswordsConfig.java:731)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:304)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.coerce(DescribableModel.java:474)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.coerceList(DescribableModel.java:585)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.coerce(DescribableModel.java:458)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.buildArguments(DescribableModel.java:409)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:329)
16:22:53  Caused: java.lang.IllegalArgumentException: Could not instantiate {varMaskRegexes=[{name=null, value={$class=VarMaskRegex, regex=token:[^,]*}}]} for com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:334)
16:22:53  	at org.jenkinsci.plugins.structs.describable.UninstantiatedDescribable.instantiate(UninstantiatedDescribable.java:208)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.coerce(DescribableModel.java:466)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.buildArguments(DescribableModel.java:409)
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:329)
16:22:53  Caused: java.lang.IllegalArgumentException: Could not instantiate {delegate=@maskPasswords(varMaskRegexes=[{name=null, value={$class=VarMaskRegex, regex=token:[^,]*}}])} for org.jenkinsci.plugins.workflow.steps.CoreWrapperStep
16:22:53  	at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:334)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.DSL.invokeStep(DSL.java:305)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.DSL.invokeDescribable(DSL.java:502)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.DSL.invokeMethod(DSL.java:199)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsScript.invokeMethod(CpsScript.java:124)
16:22:53  	at org.codehaus.groovy.runtime.callsite.PogoMetaClassSite.call(PogoMetaClassSite.java:47)
16:22:53  	at org.codehaus.groovy.runtime.callsite.CallSiteArray.defaultCall(CallSiteArray.java:47)
16:22:53  	at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:116)
16:22:53  	at com.cloudbees.groovy.cps.sandbox.DefaultInvoker.methodCall(DefaultInvoker.java:20)
16:22:53  Caused: java.lang.IllegalArgumentException: Failed to prepare maskPasswords step
16:22:53  	at org.jenkinsci.plugins.workflow.cps.DSL.invokeDescribable(DSL.java:504)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.DSL.invokeMethod(DSL.java:199)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsScript.invokeMethod(CpsScript.java:124)
16:22:53  	at org.codehaus.groovy.runtime.callsite.PogoMetaClassSite.call(PogoMetaClassSite.java:47)
16:22:53  	at org.codehaus.groovy.runtime.callsite.CallSiteArray.defaultCall(CallSiteArray.java:47)
16:22:53  	at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:116)
16:22:53  	at com.cloudbees.groovy.cps.sandbox.DefaultInvoker.methodCall(DefaultInvoker.java:20)
16:22:53  	at githubAppToken.getToken(githubAppToken.groovy:87)
16:22:53  	at githubAppToken.call(githubAppToken.groovy:47)
16:22:53  	at githubCheck.call(githubCheck.groovy:37)
16:22:53  	at notifyBuildResult.aggregateGitHubCheck(notifyBuildResult.groovy:247)
16:22:53  	at notifyBuildResult.notifyIfNewBuildNotRunning(notifyBuildResult.groovy:225)
16:22:53  	at notifyBuildResult.aggregateGitHubCheck(notifyBuildResult.groovy:230)
16:22:53  	at notifyBuildResult.call(notifyBuildResult.groovy:113)
16:22:53  	at ___cps.transform___(Native Method)
16:22:53  	at com.cloudbees.groovy.cps.impl.ContinuationGroup.methodCall(ContinuationGroup.java:86)
16:22:53  	at com.cloudbees.groovy.cps.impl.FunctionCallBlock$ContinuationImpl.dispatchOrArg(FunctionCallBlock.java:113)
16:22:53  	at com.cloudbees.groovy.cps.impl.FunctionCallBlock$ContinuationImpl.fixArg(FunctionCallBlock.java:83)
16:22:53  	at sun.reflect.GeneratedMethodAccessor695.invoke(Unknown Source)
16:22:53  	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
16:22:53  	at java.lang.reflect.Method.invoke(Method.java:498)
16:22:53  	at com.cloudbees.groovy.cps.impl.ContinuationPtr$ContinuationImpl.receive(ContinuationPtr.java:72)
16:22:53  	at com.cloudbees.groovy.cps.impl.ClosureBlock.eval(ClosureBlock.java:46)
16:22:53  	at com.cloudbees.groovy.cps.Next.step(Next.java:83)
16:22:53  	at com.cloudbees.groovy.cps.Continuable$1.call(Continuable.java:174)
16:22:53  	at com.cloudbees.groovy.cps.Continuable$1.call(Continuable.java:163)
16:22:53  	at org.codehaus.groovy.runtime.GroovyCategorySupport$ThreadCategoryInfo.use(GroovyCategorySupport.java:136)
16:22:53  	at org.codehaus.groovy.runtime.GroovyCategorySupport.use(GroovyCategorySupport.java:275)
16:22:53  	at com.cloudbees.groovy.cps.Continuable.run0(Continuable.java:163)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.access$001(SandboxContinuable.java:18)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.run0(SandboxContinuable.java:51)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsThread.runNextChunk(CpsThread.java:187)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.run(CpsThreadGroup.java:420)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.access$400(CpsThreadGroup.java:95)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:330)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:294)
16:22:53  	at org.jenkinsci.plugins.workflow.cps.CpsVmExecutorService$2.call(CpsVmExecutorService.java:67)
16:22:53  	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
16:22:53  	at hudson.remoting.SingleLaneExecutorService$1.run(SingleLaneExecutorService.java:139)
16:22:53  	at jenkins.util.ContextResettingExecutorService$1.run(ContextResettingExecutorService.java:28)
16:22:53  	at jenkins.security.ImpersonatingExecutorService$1.run(ImpersonatingExecutorService.java:68)
16:22:53  	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
16:22:53  	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
16:22:53  	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
16:22:53  	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
16:22:53  	at java.lang.Thread.run(Thread.java:750)

petacz · 2022-09-27T10:22:55Z

Hi @pyieh,

this PR created a new issue https://issues.jenkins.io/browse/JENKINS-68885?jql=project%20%3D%20JENKINS%20AND%20component%20%3D%20mask-passwords-plugin

Do you have any plans to fix it?

Thanks

Pierson Yieh added 10 commits January 26, 2022 15:24

Add a Name field to regex patterns and forces them to be unique. Allo…

97e0c7a

…ws for human-readable label of regex patterns and makes Admin remote configuration of these patterns easier

remove commented out code

990cd0e

Merge branch 'master' of https://github.com/pyieh/mask-passwords-plugin

1a589fd

style fixes

5aef7d8

style fixes

4982559

Added helper methods to make Admin configuration via groovy scripts e…

7efb9a2

…asier

update clear()

5d287cb

Add save()'s to helper configuration methods, fixed remove()

82e56ea

Update removeGlobalVarMaskRegex() to only remove entries if both name…

84d81bf

… and regex match

Fixed spotBugs NP

73fe1d7

pyieh mentioned this pull request Apr 15, 2022

Mask Passwords Ownership jenkins-infra/repository-permissions-updater#2339

Merged

14 tasks

Removed save() from clear() and made a helper method

644e7cc

pyieh requested a review from timja April 20, 2022 22:54

ramapalani approved these changes Apr 20, 2022

View reviewed changes

pyieh merged commit e382f25 into jenkinsci:master May 16, 2022

v1v mentioned this pull request Aug 18, 2022

Support for mask-passwords@3.2 elastic/apm-pipeline-library#1844

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unique Names for Regex Patterns #27

Unique Names for Regex Patterns #27

pyieh commented Apr 15, 2022

ramapalani left a comment

pyieh commented May 17, 2022

pyieh commented May 24, 2022 •

edited

Loading

pyieh commented May 25, 2022

jglick commented May 26, 2022

Faheetah commented Aug 17, 2022

pyieh commented Aug 17, 2022

Faheetah commented Aug 17, 2022

v1v commented Aug 18, 2022

v1v commented Aug 18, 2022

petacz commented Sep 27, 2022

Unique Names for Regex Patterns #27

Unique Names for Regex Patterns #27

Conversation

pyieh commented Apr 15, 2022

ramapalani left a comment

Choose a reason for hiding this comment

pyieh commented May 17, 2022

pyieh commented May 24, 2022 • edited Loading

pyieh commented May 25, 2022

jglick commented May 26, 2022

Faheetah commented Aug 17, 2022

pyieh commented Aug 17, 2022

Faheetah commented Aug 17, 2022

v1v commented Aug 18, 2022

v1v commented Aug 18, 2022

petacz commented Sep 27, 2022

pyieh commented May 24, 2022 •

edited

Loading