[JENKINS-34410] Improved the search procedure of through SCMSourceCriteria #50

recena · 2016-04-21T13:12:48Z

This is an alternative to jenkinsci/workflow-multibranch-plugin#3

Better management of log message
Only one request to GitHub API

@reviewbybees

ghost · 2016-04-21T13:13:38Z

This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation.

…h SCMScourceCriteria

amuniz · 2016-04-21T14:09:32Z

No strong opinion, but by design #50 is better as SCMSource implementations should limit themselves to answer the given question: does this path exist? - without making any assumption.

recena · 2016-04-21T14:32:55Z

This is a strong opinion since you have two alternatives and choose one of them.

In the ticket description there are two positive things. IMO, this alternative is still better.

recena · 2016-04-21T14:34:47Z

does this path exist?

Exactly, I reply to this question and additionally, provide more contextual information to cover specific scenarios.

amuniz · 2016-04-21T14:41:09Z

This is a strong opinion

Well, not really, as I'm ok with this to be merged too (it's an opinion, but not strong 😄 )

stephenc · 2016-04-21T14:48:46Z

🐝 if you value my opinion

recena · 2016-04-21T14:58:10Z

@stephenc your opinion is always welcome!

recena · 2016-04-22T09:07:21Z

Although this PR is ready to be merged, I prefer to wait the @jglick's opinion.

jglick · 2016-04-22T15:12:46Z

This is an alternative to #50

Huh? This is #50! Did you mean an alternative to jenkinsci/workflow-multibranch-plugin#3?

jglick · 2016-04-22T15:13:37Z

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

+                                return true;
+                            }
+                            if (content.getName().equalsIgnoreCase(path)) {
+                                listener.getLogger().format("      %s not found (but found %s, search is case sensitive) in this %s, skipping", path, content.getName(), thing);


Might want to use ‘%s’ to make it clearer that we are quoting pathnames here.

jglick · 2016-04-22T15:14:44Z

🐝 assuming you tried it and it seems to behave nicely. Looks right.

recena · 2016-04-22T15:29:16Z

Huh? This is #50!

My mistake, too many PRs at the same time 😵

I meant jenkinsci/workflow-multibranch-plugin#3

recena · 2016-04-22T16:31:39Z

Please, find an example:

Started
Connecting to github.com with no credentials, anonymous access
Looking up recena/workflow-helloworld

  Getting remote branches...

    Checking branch JENKINS-33306
      ‘Jenkinsfile’ exists in this branch
    Met criteria
Scheduling build for branch: JENKINS-33306

    Checking branch master
      ‘Jenkinsfile’ exists in this branch
    Met criteria
Scheduling build for branch: master

    Checking branch sensitive
      ‘Jenkinsfile’ not found (but found ‘jenkinsfile’, search is case sensitive) in this branch, skipping
    Does not meet criteria

  2 branches were processed

  Getting remote pull requests...

  0 pull requests were processed

Done examining recena/workflow-helloworld

Finished: SUCCESS

recena · 2016-04-22T16:33:14Z

@jglick Your re-bee would be fine if you agree with my last commit.

jglick · 2016-04-26T15:38:23Z

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

                }
+                listener.getLogger().format("      %s does not exist in this %s%n", path, thing);


Might want to put quotes around the pathname here for consistency with the other two messages.

@jglick Addressed here 845e33e

recena · 2016-04-26T19:13:03Z

@jglick I did some tests:

Lanzada por el usuario anonymous
Connecting to github.com using recena/****** (recena GH PAT)
Looking up recena/workflow-helloworld

  Getting remote branches...

    Checking branch JENKINS-33306
      ‘mymagicfolder/Jenkinsfile’ does not exist in this branch
    Does not meet criteria

    Checking branch master
      ‘mymagicfolder/Jenkinsfile’ does not exist in this branch
    Does not meet criteria

    Checking branch sensitive
      ‘mymagicfolder/Jenkinsfile’ not found (but found ‘jenkinsfile’, search is case sensitive) in this branch, skipping
    Does not meet criteria

  0 branches were processed

  Getting remote pull requests...

  0 pull requests were processed

Done examining recena/workflow-helloworld

Finished: SUCCESS

recena · 2016-04-26T19:30:19Z

@jglick Do you agree? 8fcc303

jglick · 2016-04-26T19:33:31Z

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

+                            }
+                            if (content.getName().equalsIgnoreCase(filename)) {
+                                listener.getLogger().format("      ‘%s’ not found (but found ‘%s’, search is case sensitive) in this %s, skipping%n", path, content.getName(), thing);
+                                return false;


🐜 not quite right, since if you have a repo with both Jenkinsfile and jenkinsfile you would want to return true, even if we encountered jenkinsfile first. Unlikely, but at any rate would be more correct to delete this statement and let it fall through to the end of the method.

@jglick I thought about it but I decided not to considerer it. As you always say Do not add code if there are not real use cases at least you say that for new API, etc...

This PR improves a real use case that I found few weeks ago.

I agree, this is a corner case easily diagnosable by the user looking at the logs.

I brought it up mainly because it is a regression: before this PR the branch would correctly be recognized, now it will not. As noted, it is unlikely to occur, and easily enough diagnosed.

@jglick I prefer the positive things that this PR provided than the hypothetical issue it would be having a repository with both Jenkinsfile and jenkinsfile.

jglick · 2016-04-26T19:36:41Z

🐝

amuniz · 2016-04-27T09:54:39Z

re-:bee:

* Initialize transient fields after XStream deserialization * Re-wrote test to actually restart Jenkins * Replace RestartableJenkinsRule.addStep(Statement) with .then(Step)

recena changed the title ~~Improved the search of SCRIPT_FILE (aka Jenkinsfile)~~ Improved the search procedure of through SCMSourceCriteria Apr 21, 2016

recena force-pushed the case-sensitive branch from 9b42450 to 4ccf095 Compare April 21, 2016 13:27

Improved the search procedure of SCRIPT_FILE (aka Jenkinsfile) throug…

4e36fc3

…h SCMScourceCriteria

recena force-pushed the case-sensitive branch from 4ccf095 to 4e36fc3 Compare April 21, 2016 13:33

jglick reviewed Apr 22, 2016
View reviewed changes

jglick mentioned this pull request Apr 22, 2016

Warn if jenkinsfile is encountered when searching for Jenkinsfile jenkinsci/workflow-multibranch-plugin#3

Closed

Removed an unnecessary try/catch block and solved a little bug

95f9e89

jglick reviewed Apr 26, 2016
View reviewed changes

Quotes forgotten

845e33e

Performs the search assuming other path than the root

8fcc303

jglick reviewed Apr 26, 2016
View reviewed changes

Simplified the error handling

7f3c4b6

recena merged commit a10e869 into jenkinsci:master Apr 27, 2016

recena changed the title ~~Improved the search procedure of through SCMSourceCriteria~~ [JENKINS-34410] Improved the search procedure of through SCMSourceCriteria Apr 27, 2016

recena mentioned this pull request Jun 21, 2016

[JENKINS-33161] Customized PR build behavior #60

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-34410] Improved the search procedure of through SCMSourceCriteria #50

[JENKINS-34410] Improved the search procedure of through SCMSourceCriteria #50

recena commented Apr 21, 2016 •

edited

ghost commented Apr 21, 2016

amuniz commented Apr 21, 2016

recena commented Apr 21, 2016

recena commented Apr 21, 2016

amuniz commented Apr 21, 2016

stephenc commented Apr 21, 2016

recena commented Apr 21, 2016

recena commented Apr 22, 2016

jglick commented Apr 22, 2016

jglick Apr 22, 2016

jglick commented Apr 22, 2016

recena commented Apr 22, 2016

recena commented Apr 22, 2016

recena commented Apr 22, 2016

jglick Apr 26, 2016

recena Apr 26, 2016

recena commented Apr 26, 2016

recena commented Apr 26, 2016

jglick Apr 26, 2016

recena Apr 27, 2016

amuniz Apr 27, 2016

jglick Apr 27, 2016

recena Apr 27, 2016

jglick commented Apr 26, 2016

amuniz commented Apr 27, 2016

		}
		listener.getLogger().format(" %s does not exist in this %s%n", path, thing);

[JENKINS-34410] Improved the search procedure of through SCMSourceCriteria #50

[JENKINS-34410] Improved the search procedure of through SCMSourceCriteria #50

Conversation

recena commented Apr 21, 2016 • edited

ghost commented Apr 21, 2016

amuniz commented Apr 21, 2016

recena commented Apr 21, 2016

recena commented Apr 21, 2016

amuniz commented Apr 21, 2016

stephenc commented Apr 21, 2016

recena commented Apr 21, 2016

recena commented Apr 22, 2016

jglick commented Apr 22, 2016

Choose a reason for hiding this comment

jglick commented Apr 22, 2016

recena commented Apr 22, 2016

recena commented Apr 22, 2016

recena commented Apr 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

recena commented Apr 26, 2016

recena commented Apr 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jglick commented Apr 26, 2016

amuniz commented Apr 27, 2016

recena commented Apr 21, 2016 •

edited