Skip to content

[JENKINS-15003] Track and verify plugins mentioned in configuration XML #12926

Closed
Closed
[JENKINS-15003] Track and verify plugins mentioned in configuration XML#12926
Labels
component:coreenhancementimported-jira-issuepriority:majorresolution:fixed

Description

@jenkins-infra-bot
jenkins-infra-bot
opened on Aug 30, 2012

Many jobs or other model objects require certain plugins. This should be represented in the actual config.xml, e.g.


  "hello 1.5">

(XML namespaces would in some ways be natural for this, but XStream probably is more comfortable with a simple attribute on the outermost element “owned” by a plugin.)

Need to make XmlFile.write insert these attributes as it serializes configuration, perhaps by making it take some interface implemented by PluginManager mapping Class to String shortName × String version. JRubyXStreamConverter might be used for inspiration.

onLoad can either ignore these attributes, or use them as hints—for example, silently ignoring deserialization failures from a section owned by a plugin which is not currently loaded.

Web methods like doCreateItem and doConfigDotXml, and their corresponding Java methods like createProjectFromXML and updateByXml, can be left alone, but a caller needs some way of first checking whether all required plugins are present, and attempting to install them if not. So there needs to be a web method on Jenkins and a corresponding Java method which can be given an arbitrary XML file and will return:

  1. OK, if all plugins mentioned therein are present. (Perhaps also check versions.)
  2. A security error, if caller is missing ADMINISTER permission.
  3. Or a list of jobs given as UpdateCenterJob.id (introduced in a3e57da) indicating ongoing progress of installing (or updating?) plugins, and perhaps even restarting Jenkins (trackable as of 4bd0696) for those plugins which require it.

May also want some higher-level convenience interface, e.g. in CLI, to validate XML and wait for all update center jobs to complete (including restart as of 9ae0ba0).

Originally reported by jglick, imported from: Track and verify plugins mentioned in configuration XML
  • assignee: jglick
  • status: Resolved
  • priority: Major
  • component(s): core
  • label(s): api, plugin, xml
  • resolution: Fixed
  • resolved: 2012-09-14T22:10:37+00:00
  • votes: 0
  • watchers: 2
  • imported: 2025-11-24
Raw content of original issue 
Many jobs or other model objects require certain plugins. This should be represented in the actual config.xml, e.g.





<builders>
  <org.jenkinsci.plugins.hello.HelloWorldBuilder plugin="hello 1.5">
    <idiosyncraticConfig/>
  </org.jenkinsci.plugins.hello.HelloWorldBuilder>
</builders>





(XML namespaces would in some ways be natural for this, but XStream probably is more comfortable with a simple attribute on the outermost element “owned” by a plugin.)


Need to make XmlFile.write insert these attributes as it serializes configuration, perhaps by making it take some interface implemented by PluginManager mapping Class to String shortName × String version. JRubyXStreamConverter might be used for inspiration.


onLoad can either ignore these attributes, or use them as hints—for example, silently ignoring deserialization failures from a section owned by a plugin which is not currently loaded.


Web methods like doCreateItem and doConfigDotXml, and their corresponding Java methods like createProjectFromXML and updateByXml, can be left alone, but a caller needs some way of first checking whether all required plugins are present, and attempting to install them if not. So there needs to be a web method on Jenkins and a corresponding Java method which can be given an arbitrary XML file and will return:


    
	
  1. OK, if all plugins mentioned therein are present. (Perhaps also check versions.)
    2. 
	
  2. A security error, if caller is missing ADMINISTER permission.
    3. 
	
  3. Or a list of jobs given as UpdateCenterJob.id (introduced in a3e57da) indicating ongoing progress of installing (or updating?) plugins, and perhaps even restarting Jenkins (trackable as of 4bd0696) for those plugins which require it.
    4. 



May also want some higher-level convenience interface, e.g. in CLI, to validate XML and wait for all update center jobs to complete (including restart as of 9ae0ba0).

Activity

  1. jenkins-infra-bot commented on Sep 7, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 7, 2012
    Author
    jglick:

    https://github.com/jglick/jenkins/compare/track-plugins-15003

  2. jenkins-infra-bot commented on Sep 14, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 14, 2012
    Author
    jglick:

    Something like https://github.com/jenkinsci/cli-channel-demo/blob/master/src/main/java/org/jenkinsci/demo/cli/App.java (CLI.upgrade) could suffice for a convenient remote API, especially if the client were enhanced to automatically reconnect after a server restart.

  3. jenkins-infra-bot commented on Sep 14, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 14, 2012
    Author
    jglick:
    • Original comment link
    • Raw content of original comment: 
      To find the list of update jobs using the remote API:
      


      

      curl -g 'http://localhost:8080/updateCenter/api/json?pretty&tree=jobs[id,type,status[type],plugin[name,version]]'

    To find the list of update jobs using the remote API:

    curl -g 'http://localhost:8080/updateCenter/api/json?pretty&tree=jobs[id,type,status[type],plugin[name,version]]'

  4. jenkins-infra-bot commented on Sep 14, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 14, 2012
    Author
    jglick:
    • Original comment link
    • Raw content of original comment: 
      To prevalidate a job:
      


      

      curl -i -d @config.xml http://localhost:8080/pluginManager/prevalidateConfig

      

      

      and note the X-Jenkins-Session for later. To track its progress:
      

      

      (while :; do curl -ig 'http://localhost:8080/updateCenter/api/json?pretty&tree=jobs[id,type,status[type],plugin[name,version]]'; sleep 1; done)

      

      

      Initially all plugins will show e.g.
      

      

      {
  "id" : 1,
  "type" : "InstallationJob",
  "status" : {
    "type" : "Pending"
  },
  "plugin" : {
    "name" : "htmlpublisher",
    "version" : "1.0"
  }
}

      

      

      but when done they will show
      

      

      {
   "id" : 1,
   "type" : "InstallationJob",
   "status" : {
     "type" : "Success"
   },
   "plugin" : {
     "name" : "htmlpublisher",
     "version" : "1.0"
   }
 }

      

      

      If you see "SuccessButRequiresRestart" then you must
      

      

      curl -d '' http://localhost:8080/updateCenter/safeRestart

      

      

      and then poll on
      

      

      curl -I 'http://localhost:8080/'

      

      

      or (more efficiently) any …/api/… such as
      

      

      curl -i 'http://localhost:8080/updateCenter/api/json?tree=none'

      

      

      until you get a 200 status with a new X-Jenkins-Session indicating that the server has restarted.
      

      Now you may actually use the XML:
      

      

      curl -d @/tmp/config.xml -H 'Content-Type: text/xml' 'http://localhost:8080/createItem?name=newjob'

    To prevalidate a job:

    curl -i -d @​config.xml http://localhost:8080/pluginManager/prevalidateConfig

    and note the X-Jenkins-Session for later. To track its progress:

    (while :; do curl -ig 'http://localhost:8080/updateCenter/api/json?pretty&tree=jobs[id,type,status[type],plugin[name,version]]'; sleep 1; done)

    Initially all plugins will show e.g.

    {
  "id" : 1,
  "type" : "InstallationJob",
  "status" : {
    "type" : "Pending"
  },
  "plugin" : {
    "name" : "htmlpublisher",
    "version" : "1.0"
  }
}

    but when done they will show

    {
   "id" : 1,
   "type" : "InstallationJob",
   "status" : {
     "type" : "Success"
   },
   "plugin" : {
     "name" : "htmlpublisher",
     "version" : "1.0"
   }
 }

    If you see "SuccessButRequiresRestart" then you must

    curl -d '' http://localhost:8080/updateCenter/safeRestart

    and then poll on

    curl -I 'http://localhost:8080/'

    or (more efficiently) any …/api/… such as

    curl -i 'http://localhost:8080/updateCenter/api/json?tree=none'

    until you get a 200 status with a new X-Jenkins-Session indicating that the server has restarted.

    Now you may actually use the XML:

    curl -d @/tmp/config.xml -H 'Content-Type: text/xml' 'http://localhost:8080/createItem?name=newjob'

  5. jenkins-infra-bot commented on Sep 14, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 14, 2012
    Author
    jglick:

    #566

  6. jenkins-infra-bot commented on Sep 14, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Sep 14, 2012
    Author
    jglick:

    e1b7ac2

  7. jenkins-infra-bot
    closed this as completedon Sep 14, 2012

  8. jenkins-infra-bot commented on Dec 7, 2012

    @jenkins-infra-bot
    jenkins-infra-bot
    on Dec 7, 2012
    Author
    jglick:

    Convenience client: https://github.com/jenkinsci/install-necessary-plugins

  9. jenkins-infra-bot
    added
    imported-jira-issue
    component:core
    enhancement
    priority:major
    resolution:fixed
    on Nov 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    component:coreenhancementimported-jira-issuepriority:majorresolution:fixed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions