[JIRA] (JENKINS-57508) NodeJSInstallation "home" parameter required but not documented

[michele.ma...@aton.com (JIRA)]

Title: Message Title

Michele Mauro created an issue   Jenkins / JENKINS-57508 NodeJSInstallation "home" parameter required but not documented Issue Type: Bug Assignee: Ewelina Wilkosz Components: configuration-as-code-plugin, nodejs-plugin Created: 2019-05-16 15:36 Environment: jenkins 2.164.3 nodejs-plugin 1.2.9 configuration-as-code-plugin 1.13 Labels: plugin user-experience configuration Priority: Minor Reporter: Michele Mauro When configuring a NodeJS installation with the Configuration as Code plugin, the "home" argument of the NodeJSInstallation class constructor is required and its absence prevents the Jenkins instance to start. The bug is that it is not clear from the configuration UI, nor from an export of a working configuration, nor from any documentation that such a value is required, or what should be its value. In fact, just specifying it as an empty string solves the problem. Related github issue: https://github.com/jenkinsci/configuration-as-code-plugin/issues/701 Related code: https://github.com/jenkinsci/nodejs-plugin/blob/2d459b1507a763ef14303b3c7b727863ffd974f2/src/main/java/jenkins/plugins/nodejs/tools/NodeJSInstallation.java#L70 Steps to reproduce: To have a working Jenkins instance using the Configuration as Code plugin, you must use something like the following as configuration for a NodeJS installation:   tool: nodejs: installations: - name: "Node 11.14" home: "" properties: - installSource: installers: - nodeJSinstaller: id: "11.14.0" npmPackagesRefreshHours: 72 Without the home: "" value, the instance fails to start with the following error: io.jenkins.plugins.casc.ConfiguratorException: home is required to configure class jenkins.plugins.nodejs.tools.NodeJSInstallation With the empty home value, everything works correctly. The bug is the fact that it is very hard to find (it probably requires inspection of the NodeJS plugin source code) that that value is required, is required in that position, and that an empty value is a correct default. Possible solutions:   One possible solution could be to remove the requirement on the parameter, possibly adding another constructor that sets the working empty value Another solution could be adding some documentation (it's not clear to me where, however) to guide Configuration as Code users so that they are aware of the requirement Add Comment   This message was sent by Atlassian Jira (v7.11.2#711002-sha1:fdc329d) -- You received this message because you are subscribed to the Google Groups "Jenkins Issues" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-issues+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-issues/JIRA.199410.1558021019000.233.1558021020205%40Atlassian.JIRA. For more options, visit https://groups.google.com/d/optout.