You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/03/23 14:26:23 UTC
[GitHub] [airflow] josh-fell commented on a change in pull request #22421: Add `JenkinsBuildSensor`
josh-fell commented on a change in pull request #22421:
URL: https://github.com/apache/airflow/pull/22421#discussion_r833328675
##########
File path: airflow/providers/jenkins/hooks/jenkins.py
##########
@@ -46,3 +49,20 @@ def __init__(self, conn_id: str = default_conn_name) -> None:
def get_jenkins_server(self) -> jenkins.Jenkins:
"""Get jenkins server"""
return self.jenkins_server
+
+ def get_build_building_state(self, job_name: str, build_number: Optional[int]) -> bool:
+ """Get build building state"""
+ try:
+ if not build_number:
+ self.log.info("Build number not specified, getting latest build info from Jenkins")
+ job_info = self.jenkins_server.get_job_info(job_name)
+ build_number_to_check = job_info['lastBuild']['number']
+ else:
+ build_number_to_check = build_number
+
+ self.log.info(f"Getting build info for {job_name} build number: #{build_number_to_check}")
Review comment:
```suggestion
self.log.info("Getting build info for %s build number: #%s", job_name, build_number_to_check)
```
We shouldn't mix f-strings within logging so the formatting is not done until the very, very last moment when it's needed. You can read this [quick reference](https://dev.to/izabelakowal/what-is-the-best-string-formatting-technique-for-logging-in-python-d1d) for a little insight as to why.
##########
File path: airflow/providers/jenkins/sensors/jenkins_build.py
##########
@@ -0,0 +1,61 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import TYPE_CHECKING, Optional
+
+from airflow.providers.jenkins.hooks.jenkins import JenkinsHook
+from airflow.sensors.base import BaseSensorOperator
+
+if TYPE_CHECKING:
+ from airflow.utils.context import Context
+
+
+class JenkinsBuildSensor(BaseSensorOperator):
+ """
+ Monitor a jenkins job and pass when it is finished building. This is regardless of the build outcome.
+ This sensor depend on python-jenkins library,
+
+ :param jenkins_connection_id: The jenkins connection to use for this job
+ :param job_name: The name of the job to check
+ :param build_number: Build number to check - if None, the latest build will be used
+ """
+
+ def __init__(
+ self,
+ *,
+ jenkins_connection_id: str,
+ job_name: str,
+ build_number: Optional[int] = None,
+ **kwargs,
+ ):
+ super().__init__(**kwargs)
+ self.job_name = job_name
+ self.build_number = build_number
+ self.jenkins_connection_id = jenkins_connection_id
+
+ def poke(self, context: 'Context') -> bool:
+ self.log.info(f"Poking jenkins job {self.job_name}")
Review comment:
```suggestion
self.log.info("Poking jenkins job %s", self.job_name)
```
##########
File path: tests/providers/jenkins/sensors/test_jenkins_build.py
##########
@@ -0,0 +1,72 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+import unittest
+from unittest.mock import MagicMock, patch
+
+from parameterized import parameterized
+
+from airflow.providers.jenkins.hooks.jenkins import JenkinsHook
+from airflow.providers.jenkins.sensors.jenkins_build import JenkinsBuildSensor
+
+
+class TestJenkinsBuildSensor(unittest.TestCase):
+ @parameterized.expand(
+ [
+ (
+ 1,
+ False,
+ ),
+ (
+ None,
+ True,
+ ),
+ (
+ 3,
+ True,
+ ),
+ ]
+ )
+ @patch('jenkins.Jenkins')
+ def test_poke(self, build_number, build_state, mock_jenkins):
+ target_build_number = build_number if build_number else 10
+
+ jenkins_mock = MagicMock()
+ jenkins_mock.get_job_info.return_value = {'lastBuild': {'number': target_build_number}}
+ jenkins_mock.get_build_info.return_value = {
+ 'building': build_state,
+ }
+ mock_jenkins.return_value = jenkins_mock
+
+ with patch.object(JenkinsHook, 'get_connection') as mock_get_connection:
+ mock_get_connection.return_value = MagicMock()
+
+ sensor = JenkinsBuildSensor(
+ dag=None,
+ jenkins_connection_id="fake_jenkins_connection",
+ task_id="sensor_test",
+ job_name="a_job_on_jenkins",
+ build_number=target_build_number,
+ )
+
+ output = sensor.poke(None)
+
+ assert output == (not build_state)
+ assert jenkins_mock.get_job_info.call_count == 0 if build_number else 1
+ assert jenkins_mock.get_build_info.call_count == 1
+ jenkins_mock.get_build_info.assert_called_once_with('a_job_on_jenkins', target_build_number)
Review comment:
```suggestion
jenkins_mock.get_build_info.assert_called_once_with('a_job_on_jenkins', target_build_number)
```
These are redundant in a way and the `assert_called_once_with()` is a better assertion here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org