Refactored test suite to make sure the tests are running isolated

[ppshobi]

Hi, This is obviously a big pull request. Please take time to review it especially because this is the test suite. But I have made changes in small chunks so that the review process will be easier. That is also the reason you can see a big commit list.

I will give you an idea about the changes I have done in this PR.

• There is a base TestCase.php class which all the test classes should extend and its a place we can have the basic bootstrapping of our test suite
• Then I have gone through each test classes and removed/replaced the static methods by making use of constructor() and setup() methods as necessary and isolated each test methods to be run independently of each other. Then made sure the entire test class passes and then the whole suite. Then move on to the next class.
• One or two extra tests were added and removed as necessary. Some method extraction refactoring was done on a few tests as it would cut the duplication.

[curquiza]

Related to #23

[ppshobi]

I think the PR is ready to review. Please let me know what you think. I have some other refactorings in mind, but it would require changes in the src/ so I have refrained myself from doing it at least in this PR.

[curquiza]

Related to this issue.

[bidoubiwa]

Is it possible to add two tests in search ?
Those tests are made to see if the SDK handles correctly the fact that some search parameters can either be an array of strings or a single string.

Test 1

{
        limit: 5,
        offset: 0,
        attributesToRetrieve: ['id', 'title'],
        attributesToCrop: ['id', 'title'],
        cropLength: 6,
        attributesToHighlight: ['id', 'title'],
        filters: 'title = "Le Petit Prince"',
        matches: true,
}

You should have these keys

$this->assertArrayHasKey('_matchesInfo', $response["hits"][0]);
$this->assertArrayHasKey('title', $response["hits"][0]['_matchesInfo']);
$this->assertArrayHasKey('_formatted', $response["hits"][0]);

But not these keys:

$this->assertArrayNotHasKey('comment', $response["hits"][0]);
$this->assertArrayNotHasKey('comment', $response["hits"][0]['_matchesInfo']);

Try those value

$this->assertSame('Petit <em>Prince</em>', $response["hits"][0]["_formatted"]["title"]);

test 2

{
        limit: 5,
        offset: 0,
        attributesToRetrieve: "*",
        attributesToCrop: "*",
        cropLength: 6,
        attributesToHighlight: "*",
        filters: 'title = "Le Petit Prince"',
        matches: true,
}

You should have these keys

$this->assertArrayHasKey('_matchesInfo', $response["hits"][0]);
$this->assertArrayHasKey('_formatted', $response["hits"][0]);
$this->assertArrayHasKey('comment', $response["hits"][0])
$this->assertArrayHasKey('comment', $response["hits"][0]["_formatted"])
$this->assertArrayHasKey('title', $response["hits"][0]['_formatted']);
$this->assertArrayHasKey('title', $response["hits"][0]['_matchesInfo']);
$this->assertArrayHasKey('comment', $response["hits"][0]['_matchesInfo'])

Try those value

$this->assertSame('Petit <em>Prince</em>', $response["hits"][0]["_formatted"]["title"]);

Tests could be improved but this assure us that the strings are handled correctly!

[bidoubiwa]

Great added tests! Thanks a lot

[curquiza]

🎉

[curquiza]

Need rebasing, and we are finally done @ppshobi 🙂 🎉

[ppshobi]

Done 👍

[curquiza]

Perfeeeeeeect 👌 Thanks again @ppshobi!