fix(tests): rework test checking conversion of Detail error field

Tests should not rely on manually modified VCR cassettes. Those do not represent a real situation.

Author: agateau-gg

pygitguardian/models.py

@@ -115,7 +115,6 @@ class Detail(Base):
  api output is a simple string.
 
  Attributes:
- status_code (int): response status code
  detail (str): response string
  """
 

tests/cassettes/test_health_check_error.yaml

@@ -275,22 +275,6 @@ def test_health_check(client: GGClient):
  assert type(health.to_json()) == str
 
 
-@my_vcr.use_cassette
-def test_health_check_error(client: GGClient):
- health = client.health_check()
- assert health.status_code == 400
- assert health.detail == "Configuration error."
- assert str(health) == (
- "detail:Configuration error., status_code:400, "
- "app version:1.26.0-rc.4, secrets engine version:2.43.0"
- )
- assert bool(health) is False
- assert health.success is False
-
- assert type(health.to_dict()) == OrderedDict
- assert type(health.to_json()) == str
-
-
 @pytest.mark.parametrize(
  "name, to_scan, expected, has_secrets, has_policy_breaks",
  [

tests/test_client.py

@@ -3,6 +3,8 @@
 import pytest
 
 from pygitguardian.models import (
+ Detail,
+ DetailSchema,
  Document,
  DocumentSchema,
  HealthCheckResponseSchema,
@@ -110,6 +112,11 @@ def test_document_handle_0_bytes(self):
  ScanResult,
  {"policy_break_count": 1, "policy_breaks": [], "policies": []},
  ),
+ (
+ DetailSchema,
+ Detail,
+ {"detail": "Fail"},
+ ),
  ],
  )
  def test_schema_loads(self, schema_klass, expected_klass, instance_data):
@@ -125,3 +132,12 @@ def test_schema_loads(self, schema_klass, expected_klass, instance_data):
 
  obj = schema.load(data)
  assert isinstance(obj, expected_klass)
+
+ def test_detail_renames_error_field(self):
+ """
+ GIVEN a Detail JSON dict with an `error` field instead of a `detail` field
+ WHEN loading using the schema
+ THEN the created Detail instance contains a `detail` field with the right value
+ """
+ detail = Detail.SCHEMA.load({"error": "An error message"})
+ assert detail.detail == "An error message"