[API] New branch for adding the testsuite for the API + addressed comments

[spell00]

Creation of a test suite for the API.

[xlecours]

Some change requested.

Overall, I see that you are trying to programatically test each endpoints from an array on strings. Whilst this could be a good way to save lines of code, it creates two really convoluted functions (_allNamesGet and _allNamesPost)

Since we are using PHPUnit to run our test, it is good practice to have a test for each functionality/feature. I would prefer to have a test... function for each endpoint that would allow more specific handling and more control over the cyclomatic complexity of our code. (@johnsaigle)

ex:

public function testCandidatesPOST(): void
{
    $payload = ['DoB': "2010-01-01", ....];
    $response = $this->_client->request('POST', $this->_base_uri . '/candidates', $payload);
    $this->assertEquals($response->getStatus(), '201', 'Candidate not created');
    $body = json_decode($response->getBody()->getContent(), true);
    $this->assertArrayHasKey($body, 'CandID');
}

Otherwise, if you want to keep the array of endpoints, PHPUnit also provides a Data provider functionality that allows to create an array of parameters and expected results to pass as parameters of tests functions.
see: https://phpunit.readthedocs.io/en/9.0/writing-tests-for-phpunit.html?highlight=generator#data-providers

[spell00]

Thank you for your feedback @xlecours , I'll address your comments soon

[christinerogers]

@spell00 will this be ready for the 23 release or should it be rebased to master ?

[spell00]

@christinerogers It will not be ready for the 23 release

[christinerogers]

Ok. please rebase to master

[spell00]

Rebase to master is done

[xlecours]

Here are some comments and suggestions.
It is much more explicit than the previous version 👍

I would recommend changing LorisApiTest.php for LorisApiAuthenticatedTest.php and to use the setUp mechanics of phpUnit so that guzzleLogin do not need to be explicitly called at the begining of each test.

[xlecours]

More changes.
If it is too much to make all the changes, remove the response content shape assertion and we will add them in a subsequent PR.

[spell00]

Many incomplete tests are Incomplete because their is no /data-raisinbread directory in the docker container.

[xlecours]

So change requests. Good work so far. Let's keep going!

[xlecours]

And some more :)

[spell00]

@xlecours as we discussed, the JWT key is now modified in raisinbread/test/api/LorisApiAuthenticatedTest.php, as it is only required for the API test suite, leaving test/integrationtests/LorisIntegrationTest.class.inc unchanged.

stale review

[xlecours]

@driusan This should be good to go.

oops.. somehow I accidentally dismissed @xlecour's review, not mine.

[xlecours]

@spell00 crongrats !