Support live testing for developers

[aik099]

The library has unit tests:

• we test, that the network layer (communication between library and server) behaves as expected;
• we test, that we send the correct data to the Jira.

The problem

We don't test if an API request built by the library will actually behave as expected on the Jira side. Testing stuff like that is of course out of the scope, because if we've made an API call according to the Jira REST API docs, then we believe it will work as expected.

The solution

Before sending a PR a developer must confirm, that the added code will actually produce the correct results. Here is why the ApiTest::testLive test was added.

It works like this:

1. copy/paste phpunit.xml.dist into phpunit.xml
2. in the phpunit.xml specify LIVE_TEST_ENDPOINT, LIVE_TEST_USERNAME and LIVE_TEST_PASSWORD environment variables (example code is already placed in there; just uncomment it)
3. write the desired LIVE test in the ApiTest::testLive method
4. run it
   .

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.62%. Comparing base (52b5bd6) to head (3562543).

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #221   +/-   ##
=========================================
  Coverage     64.62%   64.62%           
  Complexity      207      207           
=========================================
  Files            10       10           
  Lines           687      687           
=========================================
  Hits            444      444           
  Misses          243      243           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.