[webkit-efl] API Unit Tests

[Thiago Marcos P. Santos]

On Wed, Jul 18, 2012 at 7:10 PM, Thiago Marcos P. Santos
<tmpsantos at gmail.com> wrote:
> On Fri, Jul 13, 2012 at 1:24 AM, Thiago Marcos P. Santos
> <tmpsantos at gmail.com> wrote:
>>
>> On Tue, Jul 3, 2012 at 7:56 PM, Thiago Marcos P. Santos
>> <tmpsantos at gmail.com> wrote:
>>>
>>> Hi WebKit EFL,
>>>
>>> Thanks to the great work done by Krzysztof at the bug 68509, we have now
>>> an API Unit Test Framework for EWK.
>>>
>>> You can run the tests individually or all tests at once by calling the
>>> runner script:
>>>
>>> $ ./Tools/Scripts/run-efl-tests [--debug|--release]
>>>
>>> The runner was integrated as a step of the build bots running tests. The
>>> only thing missing now is test coverage, and I hope the EFL community can
>>> work together at the meta bug tracking the missing tests [1]. I strongly
>>> recommend if you are working on a test, to add as dependency to this bug to
>>> give visibility to all the developers involved on the task.
>>>
>>> Another suggestion would be that we do not accept any
>>> addition/modification to the APIs if there is no test backing the change.
>>> IMO this is aligned to the WebKit best practices and can only bring benefits
>>> to the port.
>>>
>>> [1] https://bugs.webkit.org/show_bug.cgi?id=90451
>>>
>>> Cheers!
>>
>>
>> And the unit test framework for WebKit 2 API has just landed! Let's make
>> unit tests also a requirement for any new API's and changes.
>>
>> https://bugs.webkit.org/show_bug.cgi?id=90606
>>
>> Cheers,
>
>
> Hi,
>
> We have now WebKit2 C API and EFL API tests running on the bots [1] and
> instructions for adding/running new EFL WebKit2 API tests [2].
>
> Can we make it official that we need unit tests as acceptance criteria for
> any changes/additions to EFL WebKit2 API and the WebKit2 C API?
>
> In any case, please remember to run the tests before submitting patches. In
> case of failure, the bots will turn red.
>
> [1]
> http://build.webkit.org/builders/EFL%20Linux%2064-bit%20Debug/builds/2967/steps/API%20tests/logs/stdio
>
> [2] http://trac.webkit.org/wiki/EFLWebKitTests
>
> Cheers,

Hi EWK!

Recently, when/how/where we should write API unit tests became the
central point of the comments reviewing bug 91832.

Once again, I would like to suggest to this list some best practices
for the EFL port. This will avoid misunderstandings in the future:

- Every new EFL feature [1] should have unit tests verifying this feature.
- The patch adding the feature should also contain the unit tests,
minimizing the time window of having untested code in the trunk. This
is the preferred approach.
- Alternatively, a test can be written in a separated bug, but the
feature can only land after the test gets r+. We have enough technical
debts [2].

[1] Features are not just new API, but it also includes things like
convenience wrappers: https://bugs.webkit.org/show_bug.cgi?id=94104
[2] https://bugs.webkit.org/show_bug.cgi?id=90451

I would like to add these lines to the WebKitEFL wiki and make it
official. Any objections?

Cheers,