Closed Bug 1246407 Opened 9 years ago Closed 9 years ago

Rename driver and client directories

Categories

(Testing :: Marionette Client and Harness, defect)

defect
Not set
normal

Tracking

(firefox47 fixed)

RESOLVED FIXED
mozilla47
Tracking Status
firefox47 --- fixed

People

(Reporter: ato, Assigned: ato)

References

Details

(Keywords: pi-marionette-client, pi-marionette-runner)

Attachments

(1 file)

Since we have not yet decided if we want to rename the marionette_driver and marionette_client Python packages to reflect what they actually do, a momentary compromise is to rename their parent directories. My suggestion is to rename testing/marionette/driver to testing/marionette/client and testing/marionette/client to testing/marionette/harness. This also avoids the file completion conflict between testing/marionette/driver.js and the testing/marionette/driver directory. This would have no practical effect on end-users or dependencies.
This change moves testing/marionette/client to testing/marionette/harness, and testing/marionette/driver to testing/marionette/client. This parent directory name change reflects the true purpose of these Python packages. Review commit: https://reviewboard.mozilla.org/r/33897/diff/#index_header See other reviews: https://reviewboard.mozilla.org/r/33897/
Attachment #8716650 - Flags: review?(dburns)
Autoland to try is currently broken, so I did a manual try run: https://treeherder.mozilla.org/#/jobs?repo=try&revision=fb5d6067e9d2
Assignee: nobody → ato
Status: NEW → ASSIGNED
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester Review request updated; see interdiff: https://reviewboard.mozilla.org/r/33897/diff/1-2/
Attachment #8716650 - Flags: review?(dburns)
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester Review request updated; see interdiff: https://reviewboard.mozilla.org/r/33897/diff/2-3/
We should ensure the the documentation can still be generated for the client, and that readthedocs.org is able to generate it. Currently, rtd.org is using the following: Requirements: testing/marionette/client/requirements.txt Doc config: testing/marionette/client/docs/conf.py I think it probably makes sense for the docs to stay in testing/marionette/client/docs as they were never moved to testing/marionette/driver/docs, despite being documentation for the client.
Blocks: 1144240
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester Review request updated; see interdiff: https://reviewboard.mozilla.org/r/33897/diff/3-4/
Attachment #8716650 - Flags: review?(dburns)
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester https://reviewboard.mozilla.org/r/33897/#review32509 ::: testing/luciddream/luciddream/runluciddream.py:105 (Diff revision 4) > -#TODO: make marionette/client/marionette/runtests.py importable so we can > +#TODO: make marionette/harnedss/marionette/runtests.py importable so we can Harness? ::: testing/marionette/client/setup.py:22 (Diff revision 4) > -setup(name='marionette_client', > +setup(name='marionette_driver', This is a breaking change because we now need to update all documentation for out of tree users ::: testing/marionette/client/setup.py:25 (Diff revision 4) > - long_description='See http://marionette-client.readthedocs.org/', > + long_description='See http://marionette-driver.readthedocs.org/', Has this been created? Since this is moving we are going to make sure the docs update properly and links to it are mostly updated (thinking MDN mostly)
Attachment #8716650 - Flags: review?(dburns)
https://reviewboard.mozilla.org/r/33897/#review32509 > This is a breaking change because we now need to update all documentation for out of tree users It isn’t a breaking change because the directories are just changing name. Review Board is failing to reflect this. The actual Python package names aren’t changing; just their containing directory names. > Has this been created? Since this is moving we are going to make sure the docs update properly and links to it are mostly updated (thinking MDN mostly) I actually didn’t change this, but you’re right that it does not exist. I will point it to http://marionette-client.readthedocs.org/en/latest/ instead.
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester Review request updated; see interdiff: https://reviewboard.mozilla.org/r/33897/diff/4-5/
Attachment #8716650 - Flags: review?(dburns)
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester https://reviewboard.mozilla.org/r/33897/#review32949
Attachment #8716650 - Flags: review?(dburns) → review+
Comment on attachment 8716650 [details] MozReview Request: Bug 1246407 - Rename parent directories for Marionette client and test harness; r?automatedtester Review request updated; see interdiff: https://reviewboard.mozilla.org/r/33897/diff/5-6/
Status: ASSIGNED → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla47
Product: Testing → Remote Protocol

Moving bugs for Marionette client due to component changes.

Component: Marionette → Marionette Client and Harness
Product: Remote Protocol → Testing
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: