Removed "encode" on color in get_job_status

[nnabb]

SUMMARY

Bug in jenkins_job module with Python3 - Could only disable a job, but never enable

Removed .encode('utf-8') from response['color'] on return of get_job_status in web_infrastructure/jenkins_job.py and wrapped it in str() for good measure. Fixes enabling/disabling Jenkins Job when using Python3 (tested in 3.8.1).

In Python3 (tested in 3.8.1), variable.encode('utf-8') returns as a byte string; returns a string in Python2 (tested in 2.7.17).

Sample Python Test

def get_json():
    return "disabled".encode('utf-8')


byte_string = str(get_json())
regular_string = "disabled"

print(type(byte_string))
print(byte_string)
print(type(regular_string))
print(regular_string)

if (byte_string == regular_string):
    print("MATCH!")
else:
    print("FAIL!")

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

• jenkins_job

ADDITIONAL INFORMATION

Expectation

Using Python3, be able to enable and disable Jenkins Job using boolean on "enabled" parameter idempotently.

Reality

Using Python3:

• Job State: Enabled | Ansible parameter "enabled: true" => No change (PASS: Expected)
• Job State: Disabled | Ansible parameter "enabled: true" => No change (FAIL: Should update)
• Job State: Enabled | Ansible parameter "enabled: false" => Change to disabled (PASS)
• Job State: Disabled | Ansible parameter "enabled: false" => Change to disabled (FAIL: Should show no change)

Reproducing:

STEP 1: Start Docker Container for Jenkins and get PASSWORD from log

docker run -p 8080:8080 -p 50000:50000 jenkins/jenkins:lts

STEP 2: Upload Jenkins Job to container (Copy XML below to a file named "config.xml")

curl -i -X POST --user "admin:<JENKINS_PASSWORD>" --data-binary "@config.xml" -H "Content-Type: text/xml" http://localhost:8080/createItem?name=Ping

config.xml (save as "config.xml" for use with curl)

<project>
<actions/>
<description/>
<keepDependencies>false</keepDependencies>
<properties/>
<scm class="hudson.scm.NullSCM"/>
<canRoam>true</canRoam>
<disabled>false</disabled>
<blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
<blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
<triggers>
<hudson.triggers.TimerTrigger>
<spec>*/2 * * * *</spec>
</hudson.triggers.TimerTrigger>
</triggers>
<concurrentBuild>false</concurrentBuild>
<builders>
<hudson.tasks.Shell>
<command>ping -c 2 localhost</command>
</hudson.tasks.Shell>
</builders>
<publishers/>
<buildWrappers/>
</project>

STEP 3: Run Playbook

ansible-playbook jenkins_job_update.yml

jenkins_job_update.yml

---
- name: Run locally
  hosts: localhost
  become: false
  gather_facts: false

  tasks:
  - name: Stop/Start Jenkins Job - Ping
    jenkins_job:
      name: "Ping"
      enabled: false
      user: admin
      password: "e80021f6300d4abfb626ffd4d029e5ff"
      url: http://localhost:8080

[ansibot]

cc @sermilrod
click here for bot help

[Akasurde]

Could you please use to_native or to_text instead? You can find the function here

[nnabb]

@Akasurde Thank you very much for the feedback! Changed to to_native.

[Akasurde]

cc @jtyr Could you please review this? Thanks in advance.

[jtyr]

It LGTM but the author of the module (@sermilrod) should review it.

[sermilrod]

I cannot merge it myself but it also LGTM 👍