Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-43693

multibranchPipelineJob overrides old branch indexing sources

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Major Major
    • job-dsl-plugin
    • None
    • Debian 8
      Jenkins 2.46.1 (as service)

      Plugins (all newest stable):
      Job DSL 1.61
      Pipeline: Multibranch 2.14
    • job-dsl 1.75

      When running the multibranchPipelineJob step it seems like it overrides the sources of a Multibranch Pipeline Job instead of just updating it. After running the step, even though nothing has changed the output of the branch indexing will become:

      Checking branch master
      ‘Jenkinsfile’ found
Met criteria
Takeover for job-dsl-plugin_multibranch » master by source #1 from source that no longer exists
Branch reopened: master (b409f3996299dd12244d6cf7f8b6d8df3aa674ca)
Scheduled build for branch: master

       

      To test this, I have installed a brand new Jenkins with the Pipeline plugins and Job DSL plugin (all as the stable version) and made a freestyle job, with a Job DSL step that has the following script:

      multibranchPipelineJob('job-dsl-plugin_multibranch') {
  branchSources {
    git { 
      remote('https://github.com/jenkinsci/job-dsl-plugin.git')
    }
  }
}

       

      After running the Job DSL step and afterwards running branch indexing a "master" job is created with the following log message from branch indexing:

      Checking branch master
      ‘Jenkinsfile’ found
Met criteria
Scheduled build for branch: master

       

      When running branch indexing again, following log message are shown as expected:

      Checking branch master
      ‘Jenkinsfile’ found
Met criteria
No changes detected: master (still at b409f3996299dd12244d6cf7f8b6d8df3aa674ca)

       

      However, if I run the Job DSL again and run branch indexing, the first log message (with takeover and so on) are shown. This is not what I would have expected, I would have expected something like a "no changes detected" message.

       

          [JENKINS-43693] multibranchPipelineJob overrides old branch indexing sources

          Vyacheslav Spiridonov added a comment -

          This is how to do it for bitbucket-branch-source:

            branchSources {
  def repo = "https://bitbucket.com/..."
    branchSource {
      source { 
        bitbucket {
          id(UUID.nameUUIDFromBytes(repo.getBytes()).toString())
          serverUrl("...")
          repository("...")
          repoOwner("...")
         ...
        }
      }
    }
  }

          Vyacheslav Spiridonov added a comment - This is how to do it for bitbucket-branch-source: branchSources { def repo = "https: //bitbucket.com/..." branchSource { source { bitbucket { id(UUID.nameUUIDFromBytes(repo.getBytes()).toString()) serverUrl( "..." ) repository( "..." ) repoOwner( "..." ) ... } } } }

          Ray Kivisto added a comment -

          Should this documentation be updated to include setting the id?

          https://jenkinsci.github.io/job-dsl-plugin/#path/multibranchPipelineJob

          Ray Kivisto added a comment - Should this documentation be updated to include setting the id ? https://jenkinsci.github.io/job-dsl-plugin/#path/multibranchPipelineJob

          J Knurek added a comment -

          I'm with rkivisto on this.

          I don't think this issue should be "Closed/Fix" if the default functionality still doesn't work as expected. 

          The ability to set the `id` does solve the problem, but in my opinion this is a workaround. And if a workaround is required, this should be clearly documented. Or even better, the default functionality should be the expected functionality. 

          J Knurek added a comment - I'm with rkivisto on this. I don't think this issue should be "Closed/Fix" if the default functionality still doesn't work as expected.  The ability to set the `id` does solve the problem, but in my opinion this is a workaround. And if a workaround is required, this should be clearly documented. Or even better, the default functionality should be the expected functionality. 

          Ray Kivisto added a comment -

          Re-opening so we can track the discussion about if this is truly fixed or not, or if we should just update the plugin documentation with the `id` setting.

          Ray Kivisto added a comment - Re-opening so we can track the discussion about if this is truly fixed or not, or if we should just update the plugin documentation with the `id` setting.

          Daniel Spilker added a comment -

          PR for improving the documentation and removing support for randomly generated identifiers:

          https://github.com/jenkinsci/job-dsl-plugin/pull/1187

          To sum things up, you need to set a constant and unique identifier for each branch source to make things work. That's a delicacy of the SCM API plugin. There must be unique identifier for each branch source, no two branch sources either in the same or different jobs may share the same ID. It's your responsibility to keep the ID unique when using Job DSL. The ID must not change over time, e.g. on the next run of the seed job.

          Daniel Spilker added a comment - PR for improving the documentation and removing support for randomly generated identifiers: https://github.com/jenkinsci/job-dsl-plugin/pull/1187 To sum things up, you need to set a constant and unique identifier for each branch source to make things work. That's a delicacy of the SCM API plugin. There must be unique identifier for each branch source, no two branch sources either in the same or different jobs may share the same ID. It's your responsibility to keep the ID unique when using Job DSL. The ID must not change over time, e.g. on the next run of the seed job.

          René Scheibe added a comment - - edited

          daspilker is there a way in Job DSL to resemble the automatic id creation as done when the job is created via the UI? Or can the id automatically be set only on job creation but not changed when updating the job?

          René Scheibe added a comment - - edited daspilker is there a way in Job DSL to resemble the automatic id creation as done when the job is created via the UI? Or can the id automatically be set only on job creation but not changed when updating the job?

          Daniel Spilker added a comment -

          renescheibe Job DSL should not replicate any plugin logic. The behavior will change over time, will most likely fail silently and cause more problems.

          I'll close this issue since there no more known problems.

          Daniel Spilker added a comment - renescheibe Job DSL should not replicate any plugin logic. The behavior will change over time, will most likely fail silently and cause more problems. I'll close this issue since there no more known problems.

          René Scheibe added a comment -

          Still an issue: Enforcing to manually set the id is only possible for branch sources explicitly implemented in Job DSL. For branch sources that are provided via "dynamic" DSL that's not enforced.

          That's for example all the sources under branchSources - branchSource which are for example:

          • bitbucket
          • git
          • github
          • mercurialSCMSource
          • subversionSCMSource

          Do you think these can also be covered somehow?

          René Scheibe added a comment - Still an issue: Enforcing to manually set the id is only possible for branch sources explicitly implemented in Job DSL. For branch sources that are provided via "dynamic" DSL that's not enforced. That's for example all the sources under branchSources - branchSource which are for example: bitbucket git github mercurialSCMSource subversionSCMSource Do you think these can also be covered somehow?

          Eugene G added a comment -

          I faced the same issue even though I don't use the Job DSL plugin to configure a GitHub Organization pipeline. It was created in UI. Any workarounds?

          Eugene G added a comment - I faced the same issue even though I don't use the Job DSL plugin to configure a GitHub Organization pipeline. It was created in UI. Any workarounds?

          Ryan Fox added a comment -

          Ditto here!  Would love to see resolution using the Job DSL plugin to configure a Gitlab Group pipeline

          Ryan Fox added a comment - Ditto here!  Would love to see resolution using the Job DSL plugin to configure a Gitlab Group pipeline

            daspilker Daniel Spilker
            anigif Anders Kielsholm
            Votes:
            1 Vote for this issue
            Watchers:
            19 Start watching this issue

              Created:
              Updated:
              Resolved: