def test_request_and_wait(self):
"""Test that the external log area provider can checkout log areas.
Approval criteria:
- The external log area provider shall request an external provider and
checkout log areas.
Test steps::
1. Initialize an external provider.
2. Send a checkout request via the external log area provider.
3. Verify that the provider returns a list of checked out log areas.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 10)
jsontas = JsonTas()
identity = PackageURL.from_string("pkg:testing/etos")
jsontas.dataset.merge(
{
"identity": identity,
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
start_id = "1"
test_id = "logarea123"
provider_id = "test_request_and_wait"
# First request is 'start'.
# Second request is 'status'.
# Third request is 'stop' which should not be requested in this test.
with FakeServer(
["ok", "ok", "no_content"],
[
{"id": start_id},
{"log_areas": [{"test_id": test_id}], "status": "DONE"},
{},
],
) as server:
ruleset = {
"id": provider_id,
"status": {"host": server.host},
"start": {"host": server.host},
"stop": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info(
"STEP: Send a checkout request via the external log area provider."
)
log_areas = provider.request_and_wait_for_log_areas()
self.logger.info(
"STEP: Verify that the provider returns a list of checked out log areas."
)
dict_log_areas = [log_area.as_dict for log_area in log_areas]
test_log_areas = [LogArea(provider_id=provider_id, test_id=test_id).as_dict]
self.assertEqual(dict_log_areas, test_log_areas)
def test_provider_status_http_exceptions(self):
"""Test that the wait method handles HTTP errors.
Approvial criteria:
- The wait method shall raise LogAreaNotAvailable on 404 errors.
- The wait method shall raise RuntimeError on 400 errors.
Test steps::
1. For status [400, 404]:
1.1 Initialize an external provider.
1.2 Send a status request for a started log area provider.
1.3 Verify that the wait method raises the correct exception.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 1)
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
self.logger.info("STEP: For status [400, 404]:")
for status, exception in (
("bad_request", RuntimeError),
("not_found", LogAreaNotAvailable),
):
with FakeServer(status, {"error": "failure"}) as server:
ruleset = {
"id": "test_provider_status_http_exceptions",
"status": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info(
"STEP: Send a status request for a started log area provider."
)
with self.assertRaises(exception):
self.logger.info(
"STEP: Verify that the wait method raises the correct exception."
)
provider.wait("1")
def test_provider_status_failed(self):
"""Test that the wait method raises LogAreaCheckoutFailed on FAILED status.
Approvial criteria:
- The wait method shall raise LogAreaCheckoutFailed on a FAILED status.
Test steps::
1. Initialize an external provider.
2. Send a status request for a started log area provider.
3. Verify that the wait method raises LogAreaCheckoutFailed.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 1)
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
description = "something failed!"
with FakeServer(
"ok", {"status": "FAILED", "description": description}
) as server:
ruleset = {
"id": "test_provider_status_failed",
"status": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info(
"STEP: Send a status request for a started log area provider."
)
with self.assertRaises(LogAreaCheckoutFailed):
self.logger.info(
"STEP: Verify that the wait method raises LogAreaCheckoutFailed."
)
provider.wait("1")
def test_provider_stop_many(self):
"""Test that it is possible to checkin an external log area provider with many
log areas.
Approval criteria:
- It shall be possible to send stop to an external log area provider
with multiple log areas.
Test steps::
1. Initialize an external provider.
2. Send a stop request for multiple log areas.
3. Verify that the stop endpoint is called.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 1)
jsontas = JsonTas()
log_areas = [
LogArea(test_log_area=1),
LogArea(test_log_area=2),
]
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
"logs": log_areas,
}
)
dict_log_areas = [log_area.as_dict for log_area in log_areas]
with FakeServer("no_content", {}) as server:
ruleset = {"id": "test_provider_stop_many", "stop": {"host": server.host}}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info("STEP: Send a stop request for multiple log areas.")
provider.checkin_all()
self.logger.info("STEP: Verify that the stop endpoint is called.")
self.assertEqual(server.nbr_of_requests, 1)
self.assertEqual(server.requests, [dict_log_areas])
def test_provider_start_http_exception(self):
"""Test that the start method tries again if there's an HTTP error.
Approval criteria:
- The start method shall try again on HTTP errors.
Test steps::
1. Initialize an external provider.
2. Send a start request that fails.
3. Verify that the start method tries again on HTTP errors.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
expected_start_id = "123"
with FakeServer(
["bad_request", "ok"], [{}, {"id": expected_start_id}]
) as server:
ruleset = {
"id": "test_provider_start_http_exception",
"start": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info("STEP: Send a start request that fails.")
start_id = provider.start(1, 2)
self.logger.info(
"STEP: Verify that the start method tries again on HTTP errors."
)
self.assertGreaterEqual(server.nbr_of_requests, 2)
self.assertEqual(start_id, expected_start_id)
def test_provider_start_timeout(self):
"""Test that the start method raises a TimeoutError.
Approval criteria:
- The start method shall raise TimeoutError if the timeout is reached.
Test steps::
1. Initialize an external provider.
2. Send a start request which will never finish.
3. Verify that the start method raises TimeoutError.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
os.environ["ETOS_DEFAULT_HTTP_TIMEOUT"] = "1"
with FakeServer("bad_request", {}) as server:
ruleset = {
"id": "test_provider_start_timeout",
"start": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info("STEP: Send a start request which will never finish.")
with self.assertRaises(TimeoutError):
self.logger.info(
"STEP: Verify that the start method raises TimeoutError."
)
provider.start(1, 2)
def test_provider_status_pending(self):
"""Test that the wait method waits on status PENDING.
Approvial criteria:
- The wait method shall call the status endpoint, waiting on PENDING.
Test steps::
1. Initialize an external provider.
2. Send a status request for a started log area provider.
3. Verify that the wait method waits on PENDING.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 10)
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
responses = [{"status": "PENDING"}, {"status": "PENDING"}, {"status": "DONE"}]
with FakeServer("ok", responses.copy()) as server:
ruleset = {
"id": "test_provider_status_pending",
"status": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info(
"STEP: Send a status request for a started log area provider."
)
provider.wait("1")
self.logger.info("STEP: Verify that the wait method waits on PENDING.")
self.assertEqual(server.nbr_of_requests, len(responses))
def test_provider_stop_timeout(self):
"""Test that the checkin method raises a TimeoutError when timed out.
Approval criteria:
- The checkin method shall raise TimeoutError when timed out.
Test steps::
1. Initialize an external provider.
2. Send a stop request for log areas that times out.
3. Verify that the checkin method raises a TimeoutError.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 1)
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
log_area = LogArea(test_log_area=1)
with FakeServer("bad_request", {}) as server:
ruleset = {
"id": "test_provider_stop_timeout",
"stop": {"host": server.host},
}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info("STEP: Send a stop request that fails.")
with self.assertRaises(TimeoutError):
self.logger.info(
"STEP: Verify that the checkin method raises a TimeoutError."
)
provider.checkin(log_area)
def test_provider_status(self):
"""Test that the wait method waits for status DONE and exits with response.
Approvial criteria:
- The wait method shall call the status endpoint and return on DONE.
Test steps::
1. Initialize an external provider.
2. Send a status request for a started log area provider.
3. Verify that the wait method returns response on DONE.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
etos.config.set("WAIT_FOR_LOG_AREA_TIMEOUT", 1)
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
test_id = "123"
with FakeServer("ok", {"status": "DONE", "test_id": test_id}) as server:
ruleset = {"id": "test_provider_status", "status": {"host": server.host}}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info(
"STEP: Send a status request for a started log area provider."
)
response = provider.wait("1")
self.logger.info(
"STEP: Verify that the wait method return response on DONE."
)
self.assertEqual(response.get("test_id"), test_id)
def test_provider_start(self):
"""Test that it is possible to start an external log area provider.
Approval criteria:
- It shall be possible to send start to an external log area provider.
Test steps::
1. Initialize an external provider.
2. Send a start request.
3. Verify that the ID from the start request is returned.
"""
etos = ETOS("testing_etos", "testing_etos", "testing_etos")
jsontas = JsonTas()
jsontas.dataset.merge(
{
"identity": PackageURL.from_string("pkg:testing/etos"),
"artifact_id": "artifactid",
"artifact_created": "artifactcreated",
"artifact_published": "artifactpublished",
"tercc": "tercc",
"dataset": {},
"context": "context",
}
)
expected_start_id = "123"
with FakeServer("ok", {"id": expected_start_id}) as server:
ruleset = {"id": "test_provider_start", "start": {"host": server.host}}
self.logger.info("STEP: Initialize an external provider.")
provider = Provider(etos, jsontas, ruleset)
self.logger.info("STEP: Send a start request.")
start_id = provider.start(1, 2)
self.logger.info(
"STEP: Verify that the ID from the start request is returned."
)
self.assertEqual(start_id, expected_start_id)