From f59ebc1cf9d59565b5c2f93244c095b64700244e Mon Sep 17 00:00:00 2001
From: Khai Do <zaro0508@gmail.com>
Date: Tue, 1 Apr 2014 22:54:59 -0700
Subject: [PATCH] add timeout-var option to the timeout module

jenkins build-timeout plugin version 1.13 has a new option[1] to expose the
timeout value via an environment variable.  Adding this option to the
equivalent jjb module.  Also created tests for the examples.

[1] https://github.com/jenkinsci/build-timeout-plugin/pull/22

Partial-Bug: #1287883
Change-Id: Ia0d6570e9aae55ceadf076716fc8ad7688ff6214
---
 jenkins_jobs/modules/wrappers.py        | 36 +++++++------------------
 tests/wrappers/fixtures/timeout001.xml  | 14 ++++++++++
 tests/wrappers/fixtures/timeout001.yaml |  6 +++++
 tests/wrappers/fixtures/timeout002.xml  | 13 +++++++++
 tests/wrappers/fixtures/timeout002.yaml |  4 +++
 tests/wrappers/fixtures/timeout003.xml  | 14 ++++++++++
 tests/wrappers/fixtures/timeout003.yaml |  7 +++++
 7 files changed, 67 insertions(+), 27 deletions(-)
 create mode 100644 tests/wrappers/fixtures/timeout001.xml
 create mode 100644 tests/wrappers/fixtures/timeout001.yaml
 create mode 100644 tests/wrappers/fixtures/timeout002.xml
 create mode 100644 tests/wrappers/fixtures/timeout002.yaml
 create mode 100644 tests/wrappers/fixtures/timeout003.xml
 create mode 100644 tests/wrappers/fixtures/timeout003.yaml

diff --git a/jenkins_jobs/modules/wrappers.py b/jenkins_jobs/modules/wrappers.py
index c9b3db08c..6e903d7c7 100644
--- a/jenkins_jobs/modules/wrappers.py
+++ b/jenkins_jobs/modules/wrappers.py
@@ -20,15 +20,6 @@ Wrappers can alter the way the build is run as well as the build output.
   :Macro: wrapper
   :Entry Point: jenkins_jobs.wrappers
 
-Example::
-
-  job:
-    name: test_job
-
-    wrappers:
-      - timeout:
-          timeout: 90
-          fail: true
 """
 
 import xml.etree.ElementTree as XML
@@ -75,6 +66,8 @@ def timeout(parser, xml_parent, data):
     :arg bool write-description: Write a message in the description
         (default false)
     :arg int timeout: Abort the build after this number of minutes (default 3)
+    :arg str timeout-var: Export an environment variable to reference the
+        timeout value (optional)
     :arg str type: Timeout type to use (default absolute)
     :arg int elastic-percentage: Percentage of the three most recent builds
         where to declare a timeout (default 0)
@@ -86,33 +79,22 @@ def timeout(parser, xml_parent, data):
      * **elastic**
      * **absolute**
 
+    Example:
 
-    Example::
+    .. literalinclude:: /../../tests/wrappers/fixtures/timeout001.yaml
 
-      wrappers:
-        - timeout:
-            timeout: 90
-            fail: true
-            type: absolute
-
-      wrappers:
-        - timeout:
-            fail: false
-            type: likely-stuck
-
-      wrappers:
-        - timeout:
-            fail: true
-            elastic-percentage: 150
-            elastic-default-timeout: 90
-            type: elastic
+    .. literalinclude:: /../../tests/wrappers/fixtures/timeout002.yaml
 
+    .. literalinclude:: /../../tests/wrappers/fixtures/timeout003.yaml
     """
     twrapper = XML.SubElement(xml_parent,
                               'hudson.plugins.build__timeout.'
                               'BuildTimeoutWrapper')
     XML.SubElement(twrapper, 'timeoutMinutes').text = str(
         data.get('timeout', 3))
+    timeout_env_var = data.get('timeout-var')
+    if timeout_env_var:
+        XML.SubElement(twrapper, 'timeoutEnvVar').text = str(timeout_env_var)
     XML.SubElement(twrapper, 'failBuild').text = str(
         data.get('fail', 'false')).lower()
     XML.SubElement(twrapper, 'writingDescription').text = str(
diff --git a/tests/wrappers/fixtures/timeout001.xml b/tests/wrappers/fixtures/timeout001.xml
new file mode 100644
index 000000000..34e0e287e
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout001.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <buildWrappers>
+    <hudson.plugins.build__timeout.BuildTimeoutWrapper>
+      <timeoutMinutes>90</timeoutMinutes>
+      <timeoutEnvVar>BUILD_TIMEOUT</timeoutEnvVar>
+      <failBuild>true</failBuild>
+      <writingDescription>false</writingDescription>
+      <timeoutPercentage>0</timeoutPercentage>
+      <timeoutMinutesElasticDefault>3</timeoutMinutesElasticDefault>
+      <timeoutType>absolute</timeoutType>
+    </hudson.plugins.build__timeout.BuildTimeoutWrapper>
+  </buildWrappers>
+</project>
\ No newline at end of file
diff --git a/tests/wrappers/fixtures/timeout001.yaml b/tests/wrappers/fixtures/timeout001.yaml
new file mode 100644
index 000000000..0d286ab5e
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout001.yaml
@@ -0,0 +1,6 @@
+wrappers:
+  - timeout:
+      timeout: 90
+      timeout-var: 'BUILD_TIMEOUT'
+      fail: true
+      type: absolute
diff --git a/tests/wrappers/fixtures/timeout002.xml b/tests/wrappers/fixtures/timeout002.xml
new file mode 100644
index 000000000..b7e1c68f8
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout002.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <buildWrappers>
+    <hudson.plugins.build__timeout.BuildTimeoutWrapper>
+      <timeoutMinutes>3</timeoutMinutes>
+      <failBuild>false</failBuild>
+      <writingDescription>false</writingDescription>
+      <timeoutPercentage>0</timeoutPercentage>
+      <timeoutMinutesElasticDefault>3</timeoutMinutesElasticDefault>
+      <timeoutType>likelyStuck</timeoutType>
+    </hudson.plugins.build__timeout.BuildTimeoutWrapper>
+  </buildWrappers>
+</project>
\ No newline at end of file
diff --git a/tests/wrappers/fixtures/timeout002.yaml b/tests/wrappers/fixtures/timeout002.yaml
new file mode 100644
index 000000000..1993efca1
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout002.yaml
@@ -0,0 +1,4 @@
+wrappers:
+  - timeout:
+      fail: false
+      type: likely-stuck
diff --git a/tests/wrappers/fixtures/timeout003.xml b/tests/wrappers/fixtures/timeout003.xml
new file mode 100644
index 000000000..c62d6ea73
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout003.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <buildWrappers>
+    <hudson.plugins.build__timeout.BuildTimeoutWrapper>
+      <timeoutMinutes>3</timeoutMinutes>
+      <timeoutEnvVar>BUILD_TIMEOUT</timeoutEnvVar>
+      <failBuild>true</failBuild>
+      <writingDescription>false</writingDescription>
+      <timeoutPercentage>150</timeoutPercentage>
+      <timeoutMinutesElasticDefault>90</timeoutMinutesElasticDefault>
+      <timeoutType>elastic</timeoutType>
+    </hudson.plugins.build__timeout.BuildTimeoutWrapper>
+  </buildWrappers>
+</project>
\ No newline at end of file
diff --git a/tests/wrappers/fixtures/timeout003.yaml b/tests/wrappers/fixtures/timeout003.yaml
new file mode 100644
index 000000000..ff9480581
--- /dev/null
+++ b/tests/wrappers/fixtures/timeout003.yaml
@@ -0,0 +1,7 @@
+ wrappers:
+    - timeout:
+        timeout-var: 'BUILD_TIMEOUT'
+        fail: true
+        elastic-percentage: 150
+        elastic-default-timeout: 90
+        type: elastic