Skip to content

Clean up public API #1223

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
Sep 14, 2017
Merged

Conversation

mpkorstanje
Copy link
Contributor

@mpkorstanje mpkorstanje commented Sep 13, 2017

Summary

Deprecate constructors and run methods of TestCase and TestStep and extract an interface for DataTable.

Details

Test(Case|Step) is exposed because it is part of the event bus protocol. However its constructors and run method have no general public use. As such they should not be part of the public api. In the long run Test(Case|Step) should be replaced with an interface.

TableConverter is not part of the public api but is used by DataTable.
By extracting the interface we can hide the details of how a data table
converts its data.

This will also be usefull once we start moving away from xstream as we
can introduce an XStreamTableConverter and SomeOtherTableConverter.

Motivation and Context

Keeping the public API neat, focused and clean will make it easier to maintain it in the future.

@mpkorstanje mpkorstanje changed the title Deprecate constructors and run methods of TestCase Deprecate constructors and run methods of TestCase and TestStep Sep 13, 2017
@mpkorstanje mpkorstanje changed the title Deprecate constructors and run methods of TestCase and TestStep Clean up public API Sep 13, 2017
TableConverter is not part of the public api but is used by DataTable.
By extracting the interface we can hide the details of how a data table
converts its data.

This will also be usefull once we start moving away from xstream as we
can introduce an XStreamTableConverter and SomeOtherTableConverter.
@mpkorstanje mpkorstanje force-pushed the restore-and-depricate-testcase-public-api branch from 479b3b0 to de46da5 Compare September 13, 2017 18:20
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.01%) to 56.197% when pulling 5908ead on restore-and-depricate-testcase-public-api into 442922b on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.01%) to 56.197% when pulling 2f35907 on restore-and-depricate-testcase-public-api into 442922b on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.01%) to 56.197% when pulling de46da5 on restore-and-depricate-testcase-public-api into 442922b on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.01%) to 56.197% when pulling de46da5 on restore-and-depricate-testcase-public-api into 442922b on master.

@brasmusson brasmusson merged commit de46da5 into master Sep 14, 2017
@mpkorstanje mpkorstanje deleted the restore-and-depricate-testcase-public-api branch September 14, 2017 19:49
mpkorstanje added a commit that referenced this pull request Sep 14, 2017
@lock
Copy link

lock bot commented Oct 24, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 24, 2018
@mpkorstanje mpkorstanje restored the restore-and-depricate-testcase-public-api branch October 4, 2019 18:18
@mpkorstanje mpkorstanje deleted the restore-and-depricate-testcase-public-api branch October 4, 2019 18:19
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants