Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.1 / _modules / airflow / contrib / operators / jenkins_job_trigger_operator.html
blob: 422b86e0b47db351b5fdf687c2c83f712910e97b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>airflow.contrib.operators.jenkins_job_trigger_operator &mdash; Airflow Documentation</title>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<script src="../../../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../../../index.html" class="icon icon-home"> Airflow
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../code.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li>airflow.contrib.operators.jenkins_job_trigger_operator</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for airflow.contrib.operators.jenkins_job_trigger_operator</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">socket</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span>
<span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.jenkins_hook</span> <span class="k">import</span> <span class="n">JenkinsHook</span>
<span class="kn">import</span> <span class="nn">jenkins</span>
<span class="kn">from</span> <span class="nn">jenkins</span> <span class="k">import</span> <span class="n">JenkinsException</span>
<span class="kn">from</span> <span class="nn">six.moves.urllib.request</span> <span class="k">import</span> <span class="n">Request</span><span class="p">,</span> <span class="n">urlopen</span>
<span class="kn">from</span> <span class="nn">six.moves.urllib.error</span> <span class="k">import</span> <span class="n">HTTPError</span><span class="p">,</span> <span class="n">URLError</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">basestring</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="n">basestring</span> <span class="o">=</span> <span class="nb">str</span> <span class="c1"># For python3 compatibility</span>
<span class="c1"># TODO Use jenkins_urlopen instead when it will be available</span>
<span class="c1"># in the stable python-jenkins version (&gt; 0.4.15)</span>
<span class="k">def</span> <span class="nf">jenkins_request_with_headers</span><span class="p">(</span><span class="n">jenkins_server</span><span class="p">,</span> <span class="n">req</span><span class="p">,</span> <span class="n">add_crumb</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> We need to get the headers in addition to the body answer</span>
<span class="sd"> to get the location from them</span>
<span class="sd"> This function is just a copy of the one present in python-jenkins library</span>
<span class="sd"> with just the return call changed</span>
<span class="sd"> :param jenkins_server: The server to query</span>
<span class="sd"> :param req: The request to execute</span>
<span class="sd"> :param add_crumb: Boolean to indicate if it should add crumb to the request</span>
<span class="sd"> :return:</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">jenkins_server</span><span class="o">.</span><span class="n">auth</span><span class="p">:</span>
<span class="n">req</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s1">&#39;Authorization&#39;</span><span class="p">,</span> <span class="n">jenkins_server</span><span class="o">.</span><span class="n">auth</span><span class="p">)</span>
<span class="k">if</span> <span class="n">add_crumb</span><span class="p">:</span>
<span class="n">jenkins_server</span><span class="o">.</span><span class="n">maybe_add_crumb</span><span class="p">(</span><span class="n">req</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">urlopen</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">jenkins_server</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>
<span class="n">response_body</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">response_headers</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
<span class="k">if</span> <span class="n">response_body</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">EmptyResponseException</span><span class="p">(</span>
<span class="s2">&quot;Error communicating with server[</span><span class="si">%s</span><span class="s2">]: &quot;</span>
<span class="s2">&quot;empty response&quot;</span> <span class="o">%</span> <span class="n">jenkins_server</span><span class="o">.</span><span class="n">server</span><span class="p">)</span>
<span class="k">return</span> <span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="n">response_body</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">),</span> <span class="s1">&#39;headers&#39;</span><span class="p">:</span> <span class="n">response_headers</span><span class="p">}</span>
<span class="k">except</span> <span class="n">HTTPError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="c1"># Jenkins&#39;s funky authentication means its nigh impossible to</span>
<span class="c1"># distinguish errors.</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">code</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">401</span><span class="p">,</span> <span class="mi">403</span><span class="p">,</span> <span class="mi">500</span><span class="p">]:</span>
<span class="c1"># six.moves.urllib.error.HTTPError provides a &#39;reason&#39;</span>
<span class="c1"># attribute for all python version except for ver 2.6</span>
<span class="c1"># Falling back to HTTPError.msg since it contains the</span>
<span class="c1"># same info as reason</span>
<span class="k">raise</span> <span class="n">JenkinsException</span><span class="p">(</span>
<span class="s1">&#39;Error in request. &#39;</span> <span class="o">+</span>
<span class="s1">&#39;Possibly authentication failed [</span><span class="si">%s</span><span class="s1">]: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">e</span><span class="o">.</span><span class="n">code</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">msg</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">elif</span> <span class="n">e</span><span class="o">.</span><span class="n">code</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">NotFoundException</span><span class="p">(</span><span class="s1">&#39;Requested item could not be found&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">timeout</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">TimeoutException</span><span class="p">(</span><span class="s1">&#39;Error in request: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">e</span><span class="p">)</span>
<span class="k">except</span> <span class="n">URLError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="c1"># python 2.6 compatibility to ensure same exception raised</span>
<span class="c1"># since URLError wraps a socket timeout on python 2.6.</span>
<span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;timed out&quot;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">TimeoutException</span><span class="p">(</span><span class="s1">&#39;Error in request: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">JenkinsException</span><span class="p">(</span><span class="s1">&#39;Error in request: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
<div class="viewcode-block" id="JenkinsJobTriggerOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.jenkins_job_trigger_operator.JenkinsJobTriggerOperator">[docs]</a><span class="k">class</span> <span class="nc">JenkinsJobTriggerOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Trigger a Jenkins Job and monitor it&#39;s execution.</span>
<span class="sd"> This operator depend on python-jenkins library,</span>
<span class="sd"> version &gt;= 0.4.15 to communicate with jenkins server.</span>
<span class="sd"> You&#39;ll also need to configure a Jenkins connection in the connections screen.</span>
<span class="sd"> :param jenkins_connection_id: The jenkins connection to use for this job</span>
<span class="sd"> :type jenkins_connection_id: string</span>
<span class="sd"> :param job_name: The name of the job to trigger</span>
<span class="sd"> :type job_name: string</span>
<span class="sd"> :param parameters: The parameters block to provide to jenkins. (templated)</span>
<span class="sd"> :type parameters: string</span>
<span class="sd"> :param sleep_time: How long will the operator sleep between each status</span>
<span class="sd"> request for the job (min 1, default 10)</span>
<span class="sd"> :type sleep_time: int</span>
<span class="sd"> :param max_try_before_job_appears: The maximum number of requests to make</span>
<span class="sd"> while waiting for the job to appears on jenkins server (default 10)</span>
<span class="sd"> :type max_try_before_job_appears: int</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;parameters&#39;</span><span class="p">,)</span>
<span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;.json&#39;</span><span class="p">,)</span>
<span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#f9ec86&#39;</span>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">jenkins_connection_id</span><span class="p">,</span>
<span class="n">job_name</span><span class="p">,</span>
<span class="n">parameters</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">sleep_time</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">max_try_before_job_appears</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">JenkinsJobTriggerOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">job_name</span> <span class="o">=</span> <span class="n">job_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="n">parameters</span>
<span class="k">if</span> <span class="n">sleep_time</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">sleep_time</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sleep_time</span> <span class="o">=</span> <span class="n">sleep_time</span>
<span class="bp">self</span><span class="o">.</span><span class="n">jenkins_connection_id</span> <span class="o">=</span> <span class="n">jenkins_connection_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_try_before_job_appears</span> <span class="o">=</span> <span class="n">max_try_before_job_appears</span>
<div class="viewcode-block" id="JenkinsJobTriggerOperator.build_job"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.jenkins_job_trigger_operator.JenkinsJobTriggerOperator.build_job">[docs]</a> <span class="k">def</span> <span class="nf">build_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">jenkins_server</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This function makes an API call to Jenkins to trigger a build for &#39;job_name&#39;</span>
<span class="sd"> It returned a dict with 2 keys : body and headers.</span>
<span class="sd"> headers contains also a dict-like object which can be queried to get</span>
<span class="sd"> the location to poll in the queue.</span>
<span class="sd"> :param jenkins_server: The jenkins server where the job should be triggered</span>
<span class="sd"> :return: Dict containing the response body (key body)</span>
<span class="sd"> and the headers coming along (headers)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Warning if the parameter is too long, the URL can be longer than</span>
<span class="c1"># the maximum allowed size</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">,</span> <span class="n">basestring</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">ast</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="n">ast</span><span class="o">.</span><span class="n">literal_eval</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
<span class="c1"># We need a None to call the non parametrized jenkins api end point</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">jenkins_server</span><span class="o">.</span><span class="n">build_job_url</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">jenkins_request_with_headers</span><span class="p">(</span><span class="n">jenkins_server</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span></div>
<div class="viewcode-block" id="JenkinsJobTriggerOperator.poll_job_in_queue"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.jenkins_job_trigger_operator.JenkinsJobTriggerOperator.poll_job_in_queue">[docs]</a> <span class="k">def</span> <span class="nf">poll_job_in_queue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">jenkins_server</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This method poll the jenkins queue until the job is executed.</span>
<span class="sd"> When we trigger a job through an API call,</span>
<span class="sd"> the job is first put in the queue without having a build number assigned.</span>
<span class="sd"> Thus we have to wait the job exit the queue to know its build number.</span>
<span class="sd"> To do so, we have to add /api/json (or /api/xml) to the location</span>
<span class="sd"> returned by the build_job call and poll this file.</span>
<span class="sd"> When a &#39;executable&#39; block appears in the json, it means the job execution started</span>
<span class="sd"> and the field &#39;number&#39; then contains the build number.</span>
<span class="sd"> :param location: Location to poll, returned in the header of the build_job call</span>
<span class="sd"> :param jenkins_server: The jenkins server to poll</span>
<span class="sd"> :return: The build_number corresponding to the triggered job</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">try_count</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">location</span> <span class="o">=</span> <span class="n">location</span> <span class="o">+</span> <span class="s1">&#39;/api/json&#39;</span>
<span class="c1"># TODO Use get_queue_info instead</span>
<span class="c1"># once it will be available in python-jenkins (v &gt; 0.4.15)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Polling jenkins queue at the url </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">location</span><span class="p">)</span>
<span class="k">while</span> <span class="n">try_count</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_try_before_job_appears</span><span class="p">:</span>
<span class="n">location_answer</span> <span class="o">=</span> <span class="n">jenkins_request_with_headers</span><span class="p">(</span><span class="n">jenkins_server</span><span class="p">,</span>
<span class="n">Request</span><span class="p">(</span><span class="n">location</span><span class="p">))</span>
<span class="k">if</span> <span class="n">location_answer</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">json_response</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">location_answer</span><span class="p">[</span><span class="s1">&#39;body&#39;</span><span class="p">])</span>
<span class="k">if</span> <span class="s1">&#39;executable&#39;</span> <span class="ow">in</span> <span class="n">json_response</span><span class="p">:</span>
<span class="n">build_number</span> <span class="o">=</span> <span class="n">json_response</span><span class="p">[</span><span class="s1">&#39;executable&#39;</span><span class="p">][</span><span class="s1">&#39;number&#39;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Job executed on Jenkins side with the build number </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="n">build_number</span><span class="p">)</span>
<span class="k">return</span> <span class="n">build_number</span>
<span class="n">try_count</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sleep_time</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The job hasn&#39;t been executed&quot;</span>
<span class="s2">&quot; after polling the queue </span><span class="si">%d</span><span class="s2"> times&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_try_before_job_appears</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">get_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">JenkinsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">jenkins_connection_id</span><span class="p">)</span>
<div class="viewcode-block" id="JenkinsJobTriggerOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.jenkins_job_trigger_operator.JenkinsJobTriggerOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">jenkins_connection_id</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
<span class="s1">&#39;Please specify the jenkins connection id to use.&#39;</span>
<span class="s1">&#39;You must create a Jenkins connection before&#39;</span>
<span class="s1">&#39; being able to use this operator&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">&#39;The jenkins_connection_id parameter is missing,&#39;</span>
<span class="s1">&#39;impossible to trigger the job&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">&quot;Please specify the job name to use in the job_name parameter&quot;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">&#39;The job_name parameter is missing,&#39;</span>
<span class="s1">&#39;impossible to trigger the job&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
<span class="s1">&#39;Triggering the job </span><span class="si">%s</span><span class="s1"> on the jenkins : </span><span class="si">%s</span><span class="s1"> with the parameters : </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">jenkins_connection_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">)</span>
<span class="n">jenkins_server</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_jenkins_server</span><span class="p">()</span>
<span class="n">jenkins_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_job</span><span class="p">(</span><span class="n">jenkins_server</span><span class="p">)</span>
<span class="n">build_number</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">poll_job_in_queue</span><span class="p">(</span>
<span class="n">jenkins_response</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Location&#39;</span><span class="p">],</span> <span class="n">jenkins_server</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sleep_time</span><span class="p">)</span>
<span class="n">keep_polling_job</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">build_info</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">while</span> <span class="n">keep_polling_job</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">build_info</span> <span class="o">=</span> <span class="n">jenkins_server</span><span class="o">.</span><span class="n">get_build_info</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span>
<span class="n">number</span><span class="o">=</span><span class="n">build_number</span><span class="p">)</span>
<span class="k">if</span> <span class="n">build_info</span><span class="p">[</span><span class="s1">&#39;result&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">keep_polling_job</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># Check if job had errors.</span>
<span class="k">if</span> <span class="n">build_info</span><span class="p">[</span><span class="s1">&#39;result&#39;</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;SUCCESS&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s1">&#39;Jenkins job failed, final state : </span><span class="si">%s</span><span class="s1">.&#39;</span>
<span class="s1">&#39;Find more information on job url : </span><span class="si">%s</span><span class="s1">&#39;</span>
<span class="o">%</span> <span class="p">(</span><span class="n">build_info</span><span class="p">[</span><span class="s1">&#39;result&#39;</span><span class="p">],</span> <span class="n">build_info</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Waiting for job to complete : </span><span class="si">%s</span><span class="s1"> , build </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span> <span class="n">build_number</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sleep_time</span><span class="p">)</span>
<span class="k">except</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">NotFoundException</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s1">&#39;Jenkins job status check failed. Final error was: </span><span class="si">%s</span><span class="s1">&#39;</span>
<span class="o">%</span> <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span><span class="p">)</span>
<span class="k">except</span> <span class="n">jenkins</span><span class="o">.</span><span class="n">JenkinsException</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s1">&#39;Jenkins call failed with error : </span><span class="si">%s</span><span class="s1">, if you have parameters &#39;</span>
<span class="s1">&#39;double check them, jenkins sends back &#39;</span>
<span class="s1">&#39;this exception for unknown parameters&#39;</span>
<span class="s1">&#39;You can also check logs for more details on this exception &#39;</span>
<span class="s1">&#39;(jenkins_url/log/rss)&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">))</span>
<span class="k">if</span> <span class="n">build_info</span><span class="p">:</span>
<span class="c1"># If we can we return the url of the job</span>
<span class="c1"># for later use (like retrieving an artifact)</span>
<span class="k">return</span> <span class="n">build_info</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>