Jenkins node helper API #1

VermaSh · 2018-03-14T18:44:44Z

The class NodeHelper partially addresses feature requests in adoptium/infrastructure#259

Add machines to Jenkins: addNewNode()
Determine machine stats
- getCpuCount(String computerName)
- getLocation(String computerName)
- getOsPatchLevel(String computerName)
- getMemory(String computerName)
- getSpaceLeftInGb(String computerName)
- getTotalSpace(String computerName)
Set machine description based on machine stats
- Machine stats retrieved from the above functions are used for the description
Determine machine capabilities
- getEndian(String computerName)
- getOsArch(String computerName)
- getOsInfo(String computerName)
Add labels to nodes based on machine capabilities
- addLabel(String computerName, String label)
  - Overwrites the labels with the ones in the arguments
  - weekly maintaince job will call this function with labels from the inventory file plus labels returned from constructLabels(String computerName)
- appendLabel(String computerName, String label)
  - does only an append
Other useful functions
- constructLabels(String computerName)
  - this function returns a string containing the default labels
  - as of right now, it only returns OS, arch and Endian (only if it is ppc running linux)
  - here is a list of labels which have been implemented so far:
    - constructOsLabel(String computerName)
    - constructCPULabel(String computerName)
    - constructMemoryLabel(String computerName)
    - constructEndianLabel(String computerName)
    - constructPlatformLabel(String computerName)
    - constructArchLabel(String computerName)
    - constructKernelLabel(String computerName)
Few side notes:
- computerName: is what the node name on Jenkins
- getComputer(String computerName)
  - This was created with the intention to have computer name validations in one place.
    At the moment it's very basic but it can be extended to enforce a standardized naming convention

- Add machines to Jenkins: - Set machine description based on machine stats - Determine machine capabilities - Add labels to nodes based on machine capabilities

karianna

This looks good overall! LMK if you'd like me to merge (would be good if you raised the issues etc so we know what to work on though).

karianna · 2018-03-15T12:08:34Z

src/NodeHelper.groovy

+
+class  NodeHelper {
+
+    // TODO: Move strings out to a config file


Raise an issue for this please.

Done! Move strings out to a config file

karianna · 2018-03-15T12:08:55Z

src/NodeHelper.groovy

+
+        String ret = "INVALID_NODE_NAME";
+
+        if (newNodeName.length() > 2) { // TODO: Some sort of validation for node names


Add an issue for the TODO

Done! Validation for node names

karianna · 2018-03-15T12:09:25Z

src/NodeHelper.groovy

+        def launcher
+        ) {
+
+        String ret = "INVALID_NODE_NAME";


ret --> nodeName?

Same goes for all usages of 'ret', can replace with more meaningful variable name

Using "ret" makes it easier to follow the return variable through a function. As for meaning, the function name, header comments, and function(s) called to update "ret" variable aid in the meaning.

karianna · 2018-03-15T12:09:37Z

src/NodeHelper.groovy

+     * @return string of labels set on the computer
+     */
+    public String addLabel(String computerName, String label) {
+        String ret = "addLabel:COMPUTER_NOT_FOUND";


ret --> label?

karianna · 2018-03-15T12:10:56Z

src/NodeHelper.groovy

+     * @return label string
+     */
+    public String constructLabels(String computerName) {
+        /* Procedure for adding support for new labels


Haul comment up

I have left that comment inside because it's for anyone who wants to add more functionality to the function. It isn't necessarily needed in the header comment of the function

karianna · 2018-03-15T12:11:17Z

src/NodeHelper.groovy

+        if (computer != null) {
+            ret = constructOsLabel(computer.getName());
+            if (getOsArch(computer.getName()).contains("ppc")
+                && getOsKernelInfo(computer.getName()).get(0).equalsIgnoreCase("linux")) {


could extract this to a helper function

Done! I'll add it to my next commit

karianna · 2018-03-15T12:11:56Z

src/NodeHelper.groovy

+
+        Computer computer = getComputer(computerName);
+        if (computer != null) {
+            ret = "hw.hypervisor.";// TODO: finish implementation, get something


Add issue in issue tracker

Done! Implement logic to get Hypervisor information

karianna · 2018-03-15T12:12:09Z

src/NodeHelper.groovy

+                    ret = getAIXOsInfo(computer);
+                    break;
+                case "zos":
+                    // ret = // TODO: find the command


Done! z/OS version

karianna · 2018-03-15T12:12:17Z

src/NodeHelper.groovy

+                    // ret = // TODO: find the command
+                    // break; 
+                case "mac":
+                    // ret = getMacOsInfo(computer);


commented out on purpose?

Yes, wasn't sure if we needed the version number since it is the same as kernel version. I implement it and check it in with the next commit

karianna · 2018-03-15T12:13:21Z

src/NodeHelper.groovy

+             * this returns an inaccurate result.
+             * This has to be fixed by the person who did the setup for the virtual
+             * machines.
+             * As of right now, we do not know how to fix the bug.


Done! Bug with cpu count on windows machine

This was actually bad on my part. I haven't had a chance to check this bug on external machines. I'll run tests regarding this on the external machines and open an issue if needed.

karianna · 2018-03-17T21:28:02Z

@VermaSh Just wanted to say thanks for opening up those issues - appreciate the admin effort!

Initial commit, Jenkins node helper API

f56bc4c

- Add machines to Jenkins: - Set machine description based on machine stats - Determine machine capabilities - Add labels to nodes based on machine capabilities

gdams approved these changes Mar 14, 2018

View reviewed changes

VermaSh changed the title ~~Initial commit, Jenkins node helper API~~ Jenkins node helper API Mar 14, 2018

karianna added the enhancement New feature or request label Mar 15, 2018

karianna reviewed Mar 15, 2018

View reviewed changes

karianna merged commit a2ae656 into adoptium:master Mar 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jenkins node helper API #1

Jenkins node helper API #1

VermaSh commented Mar 14, 2018 •

edited

Loading

karianna left a comment

karianna Mar 15, 2018

VermaSh Mar 15, 2018 •

edited

Loading

karianna Mar 15, 2018

VermaSh Mar 15, 2018

karianna Mar 15, 2018

karianna Mar 15, 2018

VermaSh Mar 16, 2018

karianna Mar 15, 2018

karianna Mar 15, 2018

VermaSh Mar 15, 2018

karianna Mar 15, 2018

VermaSh Mar 19, 2018

karianna Mar 15, 2018

VermaSh Mar 16, 2018

karianna Mar 15, 2018

VermaSh Mar 16, 2018

karianna Mar 15, 2018

VermaSh Mar 15, 2018

karianna Mar 15, 2018

VermaSh Mar 16, 2018

VermaSh Mar 17, 2018

karianna commented Mar 17, 2018


		class NodeHelper {

		// TODO: Move strings out to a config file


		String ret = "INVALID_NODE_NAME";

		if (newNodeName.length() > 2) { // TODO: Some sort of validation for node names

Jenkins node helper API #1

Jenkins node helper API #1

Conversation

VermaSh commented Mar 14, 2018 • edited Loading

karianna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VermaSh Mar 15, 2018 • edited Loading

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

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

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

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

karianna commented Mar 17, 2018

VermaSh commented Mar 14, 2018 •

edited

Loading

VermaSh Mar 15, 2018 •

edited

Loading