Skip to content

Commit

Permalink
Changing reporter subscribe contract
Browse files Browse the repository at this point in the history
Breaks compatiblity for reporters not in trunk.

Changing subscribe_to_describe(self, describe) to
subscribe_to_spec(self, spec)

I'm working to get rid of all references to describe slowly.
This is apart of the reporter cleanup story #30
  • Loading branch information
jmvrbanac committed Sep 8, 2014
1 parent 1e96e98 commit d82b7be
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 11 deletions.
3 changes: 3 additions & 0 deletions docs/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ Features and bug fixes
the --show-all-expects cli argument - gh-#46
#. Fixing the summary report colors to reflect the actual test results. - gh-#44
#. Added the ability for reporters to add their own cli arguments
#. Breaking reporter contract by switching from subscribe_to_describe(self, describe)
to subscribe_to_spec(self, spec). This is due to the slow removal of the
"describe" terminology in Specter.


Release: 0.1.15
Expand Down
6 changes: 3 additions & 3 deletions specter/reporting/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def get_name(self):
pass # pragma: no cover

@abstractmethod
def subscribe_to_describe(self, describe):
def subscribe_to_spec(self, spec):
pass # pragma: no cover


Expand Down Expand Up @@ -74,13 +74,13 @@ def can_use_reporter(self, reporter, parallel):
can_use = True
return can_use

def subscribe_all_to_describe(self, describe):
def subscribe_all_to_spec(self, spec):
""" Will automatically not subscribe reporters that are not parallel
or serial depending on the current mode.
"""
for reporter in self.reporters:
if self.can_use_reporter(reporter, self.parallel):
reporter.subscribe_to_describe(describe)
reporter.subscribe_to_spec(spec)

def finish_all(self):
[reporter.finished() for reporter in self.reporters]
Expand Down
6 changes: 3 additions & 3 deletions specter/reporting/console.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@ def output_test_case_result(self, test_case, level):
#if status == TestStatus.FAIL:
print_expects(test_case, level, self.use_color)

def subscribe_to_describe(self, describe):
describe.add_listener(TestEvent.COMPLETE, self.test_complete)
describe.add_listener(DescribeEvent.START, self.start_spec)
def subscribe_to_spec(self, spec):
spec.add_listener(TestEvent.COMPLETE, self.test_complete)
spec.add_listener(DescribeEvent.START, self.start_spec)

def test_complete(self, evt):
test_case = evt.payload
Expand Down
4 changes: 2 additions & 2 deletions specter/reporting/dots.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ def __init__(self):
def get_name(self):
return _('Dots Reporter')

def subscribe_to_describe(self, describe):
describe.add_listener(TestEvent.COMPLETE, self.test_event)
def subscribe_to_spec(self, spec):
spec.add_listener(TestEvent.COMPLETE, self.test_event)

def process_arguments(self, args):
if args.no_color:
Expand Down
4 changes: 2 additions & 2 deletions specter/reporting/xunit.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ def process_arguments(self, args):
def get_name(self):
return 'xUnit report generator'

def subscribe_to_describe(self, describe):
describe.add_listener(DescribeEvent.COMPLETE, self.describe_complete)
def subscribe_to_spec(self, spec):
spec.add_listener(DescribeEvent.COMPLETE, self.describe_complete)

def describe_complete(self, evt):
describe = evt.payload
Expand Down
2 changes: 1 addition & 1 deletion specter/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ def run(self, args):

suite = suite_type()
self.suites.append(suite)
self.reporter_manager.subscribe_all_to_describe(suite)
self.reporter_manager.subscribe_all_to_spec(suite)
suite.execute(select_metadata=select_meta,
parallel_manager=self.parallel_manager)

Expand Down

0 comments on commit d82b7be

Please sign in to comment.