Page MenuHomePhabricator
Create Task
Maniphest T183767

ApiFormatRaw doesn't have tests
Closed, ResolvedPublic
Actions

Description

In MediaWiki core, the ApiFormatRaw class is a bit special, it isn't exposed directly to users and basically spits out exactly whatever is passed to it. Regardless, we should still have tests for this functionality.

If you're not already familiar with PHPUnit tests, https://www.mediawiki.org/wiki/Manual:PHP_unit_testing/Writing_unit_tests has links to some good material on the basics of testing.

I would suggest creating something similar to ApiFormatNoneTest (instead of verifying there is no output, you'd verify the output is exactly the same...).

I'll mentor this for Google-Code-in-2017

Details

SubjectRepoBranchLines +/-
Add tests for ApiFormatRawmediawiki/coremaster+120 -0
Customize query in gerrit

Event Timeline

Legoktm created this task.Dec 29 2017, 8:58 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 29 2017, 8:58 AM
Aklapper updated the task description. (Show Details)Dec 29 2017, 4:23 PM
Aklapper moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2017 board.Dec 29 2017, 4:25 PM

Thanks! Published as https://codein.withgoogle.com/tasks/4855915557683200/

Anomie moved this task from Unsorted to Needs Code on the MediaWiki-Action-API board.Dec 30 2017, 5:09 PM
nikitavbv claimed this task.Jan 1 2018, 5:15 PM
nikitavbv subscribed.

I will add tests for this!

gerritbot subscribed.Jan 1 2018, 7:38 PM

Change 401405 had a related patch set uploaded (by Phantom42; owner: Phantom42):
[mediawiki/core@master] Add tests for ApiFormatRaw

https://gerrit.wikimedia.org/r/401405

gerritbot added a project: Patch-For-Review.Jan 1 2018, 7:38 PM
nikitavbv added a comment.Jan 1 2018, 7:45 PM

I added tests to check that basic types are correctly encoded (ApiFormatRaw does not work with arrays or objects). I also added test case to check that exception is thrown if mime type or text are not given.

Please note that I didn't use parent encodeData function, but overrode it. That is because ApiFormatRaw can't be created using module manager and requires some custom ApiResult structure.

If anything needs fixing / improving, please tell and I will do it!

gerritbot added a comment.Jan 4 2018, 9:05 PM

Change 401405 merged by jenkins-bot:
[mediawiki/core@master] Add tests for ApiFormatRaw

https://gerrit.wikimedia.org/r/401405

Legoktm closed this task as Resolved.Jan 4 2018, 9:29 PM
ReleaseTaggerBot added a project: MW-1.31-release-notes (WMF-deploy-2018-01-09 (1.31.0-wmf.16)).Jan 4 2018, 10:00 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits