Remove pipeline argument from various report fncts
The pipeline can be obtained by way of the item which was also being
passed in.
Change-Id: Ibcafa7daef3567c840a23defcab6fd40a9c6b206
Signed-off-by: Jesse Keating <omgjlk@us.ibm.com>
diff --git a/zuul/driver/gerrit/gerritreporter.py b/zuul/driver/gerrit/gerritreporter.py
index f8e8b03..90c95e3 100644
--- a/zuul/driver/gerrit/gerritreporter.py
+++ b/zuul/driver/gerrit/gerritreporter.py
@@ -25,7 +25,7 @@
name = 'gerrit'
log = logging.getLogger("zuul.GerritReporter")
- def report(self, pipeline, item):
+ def report(self, item):
"""Send a message to gerrit."""
# If the source is no GerritSource we cannot report anything here.
@@ -38,7 +38,7 @@
self.connection.canonical_hostname:
return
- message = self._formatItemReport(pipeline, item)
+ message = self._formatItemReport(item)
self.log.debug("Report change %s, params %s, message: %s" %
(item.change, self.config, message))
diff --git a/zuul/driver/github/githubreporter.py b/zuul/driver/github/githubreporter.py
index 68c6af0..45b7d4b 100644
--- a/zuul/driver/github/githubreporter.py
+++ b/zuul/driver/github/githubreporter.py
@@ -39,25 +39,25 @@
if not isinstance(self._unlabels, list):
self._unlabels = [self._unlabels]
- def report(self, pipeline, item):
+ def report(self, item):
"""Comment on PR and set commit status."""
if self._create_comment:
- self.addPullComment(pipeline, item)
+ self.addPullComment(item)
if (self._commit_status is not None and
hasattr(item.change, 'patchset') and
item.change.patchset is not None):
- self.setPullStatus(pipeline, item)
+ self.setPullStatus(item)
if (self._merge and
hasattr(item.change, 'number')):
self.mergePull(item)
if not item.change.is_merged:
- msg = self._formatItemReportMergeFailure(pipeline, item)
- self.addPullComment(pipeline, item, msg)
+ msg = self._formatItemReportMergeFailure(item)
+ self.addPullComment(item, msg)
if self._labels or self._unlabels:
self.setLabels(item)
- def addPullComment(self, pipeline, item, comment=None):
- message = comment or self._formatItemReport(pipeline, item)
+ def addPullComment(self, item, comment=None):
+ message = comment or self._formatItemReport(item)
project = item.change.project.name
pr_number = item.change.number
self.log.debug(
@@ -65,10 +65,11 @@
(item.change, self.config, message))
self.connection.commentPull(project, pr_number, message)
- def setPullStatus(self, pipeline, item):
+ def setPullStatus(self, item):
project = item.change.project.name
sha = item.change.patchset
- context = '%s/%s' % (pipeline.layout.tenant.name, pipeline.name)
+ context = '%s/%s' % (item.pipeline.layout.tenant.name,
+ item.pipeline.name)
state = self._commit_status
url = ''
if self.connection.sched.config.has_option('zuul', 'status_url'):
@@ -77,8 +78,8 @@
item.change.number,
item.change.patchset)
description = ''
- if pipeline.description:
- description = pipeline.description
+ if item.pipeline.description:
+ description = item.pipeline.description
self.log.debug(
'Reporting change %s, params %s, status:\n'
diff --git a/zuul/driver/smtp/smtpreporter.py b/zuul/driver/smtp/smtpreporter.py
index 35eb69f..1f232e9 100644
--- a/zuul/driver/smtp/smtpreporter.py
+++ b/zuul/driver/smtp/smtpreporter.py
@@ -24,9 +24,9 @@
name = 'smtp'
log = logging.getLogger("zuul.SMTPReporter")
- def report(self, pipeline, item):
+ def report(self, item):
"""Send the compiled report message via smtp."""
- message = self._formatItemReport(pipeline, item)
+ message = self._formatItemReport(item)
self.log.debug("Report change %s, params %s, message: %s" %
(item.change, self.config, message))
diff --git a/zuul/driver/sql/sqlreporter.py b/zuul/driver/sql/sqlreporter.py
index 46d538a..13f62f4 100644
--- a/zuul/driver/sql/sqlreporter.py
+++ b/zuul/driver/sql/sqlreporter.py
@@ -31,7 +31,7 @@
# TODO(jeblair): document this is stored as NULL if unspecified
self.result_score = config.get('score', None)
- def report(self, pipeline, item):
+ def report(self, item):
"""Create an entry into a database."""
if not self.connection.tables_established:
@@ -48,7 +48,7 @@
ref=item.change.refspec,
score=self.result_score,
message=self._formatItemReport(
- pipeline, item, with_jobs=False),
+ item, with_jobs=False),
)
buildset_ins_result = conn.execute(buildset_ins)
build_inserts = []
diff --git a/zuul/manager/__init__.py b/zuul/manager/__init__.py
index 7649944..6ea182b 100644
--- a/zuul/manager/__init__.py
+++ b/zuul/manager/__init__.py
@@ -165,7 +165,7 @@
report_errors = []
if len(action_reporters) > 0:
for reporter in action_reporters:
- ret = reporter.report(self.pipeline, item)
+ ret = reporter.report(item)
if ret:
report_errors.append(ret)
if len(report_errors) == 0:
diff --git a/zuul/reporter/__init__.py b/zuul/reporter/__init__.py
index 9c8e953..dc99c8b 100644
--- a/zuul/reporter/__init__.py
+++ b/zuul/reporter/__init__.py
@@ -37,7 +37,7 @@
self._action = action
@abc.abstractmethod
- def report(self, pipeline, item):
+ def report(self, item):
"""Send the compiled report message."""
def getSubmitAllowNeeds(self):
@@ -61,57 +61,55 @@
}
return format_methods[self._action]
- # TODOv3(jeblair): Consider removing pipeline argument in favor of
- # item.pipeline
- def _formatItemReport(self, pipeline, item, with_jobs=True):
+ def _formatItemReport(self, item, with_jobs=True):
"""Format a report from the given items. Usually to provide results to
a reporter taking free-form text."""
- ret = self._getFormatter()(pipeline, item, with_jobs)
+ ret = self._getFormatter()(item, with_jobs)
- if pipeline.footer_message:
- ret += '\n' + pipeline.footer_message
+ if item.pipeline.footer_message:
+ ret += '\n' + item.pipeline.footer_message
return ret
- def _formatItemReportStart(self, pipeline, item, with_jobs=True):
+ def _formatItemReportStart(self, item, with_jobs=True):
status_url = ''
if self.connection.sched.config.has_option('zuul', 'status_url'):
status_url = self.connection.sched.config.get('zuul',
'status_url')
- return pipeline.start_message.format(pipeline=pipeline,
- status_url=status_url)
+ return item.pipeline.start_message.format(pipeline=item.pipeline,
+ status_url=status_url)
- def _formatItemReportSuccess(self, pipeline, item, with_jobs=True):
- msg = pipeline.success_message
+ def _formatItemReportSuccess(self, item, with_jobs=True):
+ msg = item.pipeline.success_message
if with_jobs:
- msg += '\n\n' + self._formatItemReportJobs(pipeline, item)
+ msg += '\n\n' + self._formatItemReportJobs(item)
return msg
- def _formatItemReportFailure(self, pipeline, item, with_jobs=True):
+ def _formatItemReportFailure(self, item, with_jobs=True):
if item.dequeued_needing_change:
msg = 'This change depends on a change that failed to merge.\n'
elif item.didMergerFail():
- msg = pipeline.merge_failure_message
+ msg = item.pipeline.merge_failure_message
elif item.getConfigError():
msg = item.getConfigError()
else:
- msg = pipeline.failure_message
+ msg = item.pipeline.failure_message
if with_jobs:
- msg += '\n\n' + self._formatItemReportJobs(pipeline, item)
+ msg += '\n\n' + self._formatItemReportJobs(item)
return msg
- def _formatItemReportMergeFailure(self, pipeline, item, with_jobs=True):
- return pipeline.merge_failure_message
+ def _formatItemReportMergeFailure(self, item, with_jobs=True):
+ return item.pipeline.merge_failure_message
- def _formatItemReportDisabled(self, pipeline, item, with_jobs=True):
+ def _formatItemReportDisabled(self, item, with_jobs=True):
if item.current_build_set.result == 'SUCCESS':
- return self._formatItemReportSuccess(pipeline, item)
+ return self._formatItemReportSuccess(item)
elif item.current_build_set.result == 'FAILURE':
- return self._formatItemReportFailure(pipeline, item)
+ return self._formatItemReportFailure(item)
else:
- return self._formatItemReport(pipeline, item)
+ return self._formatItemReport(item)
- def _formatItemReportJobs(self, pipeline, item):
+ def _formatItemReportJobs(self, item):
# Return the list of jobs portion of the report
ret = ''