#179 Improve test coverage (#180)

* #179 Improve test coverage * #179 Prepare for versioned release * #179 Work on documentation * #179 Rename Error types * #179 Rename errors * #179 Prepare for versioned release
senzing-garage · Sep 5, 2024 · adc4f47 · adc4f47
1 parent 22480a2
commit adc4f47
Show file tree

Hide file tree

Showing 17 changed files with 952 additions and 625 deletions.
diff --git a/.github/coverage/testcoverage.yaml b/.github/coverage/testcoverage.yaml
@@ -15,11 +15,11 @@ local-prefix: "github.com/org/project"
 threshold:
   # (optional; default 0)
   # The minimum coverage that each file should have
-  file: 70
+  file: 95
 
   # (optional; default 0)
   # The minimum coverage that each package should have
-  package: 80
+  package: 95
 
   # (optional; default 0)
   # The minimum total coverage project should have

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning].
 
 -
 
+## [0.14.1] - 2024-09-05
+
+### Changed in 0.14.1
+
+- Change from `SzConfigManager.GetConfigList` to `SzConfigManager.GetConfigs`
+- Change from `buildOutDegree` to `buildOutDegrees`
+- Change from `recordList` to `recordKeys`
+
 ## [0.14.0] - 2024-08-19
 
 ### Changed in 0.14.0

diff --git a/bin/response-testcases.json b/bin/response-testcases.json
@@ -1,13 +1,15 @@
 {
     "SzConfigAddDataSource": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "DSRC_ID": 1
             }
         }
     },
     "SzConfigExportConfig": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "G2_CONFIG": {
                     "CFG_ATTR": [
@@ -10282,6 +10284,7 @@
     },
     "SzConfigGetDataSources": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "DATA_SOURCES": [
                     {
@@ -10424,8 +10427,9 @@
             }
         }
     },
-    "SzConfigManagerGetConfigList": {
+    "SzConfigManagerGetConfigs": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "CONFIGS": [
                     {
@@ -10444,6 +10448,7 @@
     },
     "SzConfigManagerGetConfig": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "G2_CONFIG": {
                     "CFG_ATTR": [
@@ -30357,6 +30362,7 @@
     },
     "SzDiagnosticCheckDatastorePerformance": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "insertTime": 1,
                 "numRecordsInserted": 1
@@ -30365,6 +30371,7 @@
     },
     "SzDiagnosticGetDatastoreInfo": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "dataStores": [
                     {
@@ -30378,6 +30385,7 @@
     },
     "SzDiagnosticGetFeature": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "LIB_FEAT_ID": 1,
                 "FTYPE_CODE": "NAME",
@@ -30412,6 +30420,7 @@
     },
     "SzEngineAddRecord": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "AFFECTED_ENTITIES": [],
                 "DATA_SOURCE": "blank",
@@ -30481,6 +30490,7 @@
     },
     "SzEngineDeleteRecord": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "AFFECTED_ENTITIES": [],
                 "DATA_SOURCE": "blank",
@@ -30532,7 +30542,7 @@
     },
     "SzEngineFetchNext": {
         "tests": {
-            "test-001": {}
+            "test-000": {}
         }
     },
     "SzEngineFindInterestingEntitiesByEntityID": {
@@ -30541,6 +30551,7 @@
             "pythonClass": "SzEngineFindInterestingEntitiesByEntityID"
         },
         "tests": {
+            "test-000": {},
             "test-001": {
                 "INTERESTING_ENTITIES": {
                     "ENTITIES": []
@@ -30554,6 +30565,7 @@
             "pythonClass": "SzEngineFindInterestingEntitiesByRecordID"
         },
         "tests": {
+            "test-000": {},
             "test-001": {
                 "INTERESTING_ENTITIES": {
                     "ENTITIES": []
@@ -30563,6 +30575,7 @@
     },
     "SzEngineFindNetworkByEntityID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [
                     {
@@ -32558,6 +32571,7 @@
     },
     "SzEngineFindNetworkByRecordID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [
                     {
@@ -33126,6 +33140,7 @@
     },
     "SzEngineFindPathByEntityID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [
                     {
@@ -34410,6 +34425,7 @@
     },
     "SzEngineFindPathByRecordID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [
                     {
@@ -35251,6 +35267,7 @@
     },
     "SzEngineGetEntityByEntityID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "RELATED_ENTITIES": [],
                 "RESOLVED_ENTITY": {
@@ -37098,6 +37115,7 @@
     },
     "SzEngineGetEntityByRecordID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "RELATED_ENTITIES": [],
                 "RESOLVED_ENTITY": {
@@ -37546,6 +37564,7 @@
     },
     "SzEngineGetRecord": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ADDRESS_DATA": [],
                 "ATTRIBUTE_DATA": [],
@@ -37689,11 +37708,17 @@
     },
     "SzEngineGetRedoRecord": {
         "tests": {
-            "test-001": {}
+            "test-000": {}
+        }
+    },
+    "SzEngineGetStats": {
+        "tests": {
+            "test-000": {}
         }
     },
     "SzEngineGetVirtualEntityByRecordID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "RESOLVED_ENTITY": {
                     "ENTITY_ID": 1,
@@ -41854,6 +41879,7 @@
     },
     "SzEngineHowEntityByEntityID": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "HOW_RESULTS": {
                     "FINAL_STATE": {
@@ -43883,6 +43909,7 @@
     },
     "SzEngineProcessRedoRecord": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "AFFECTED_ENTITIES": [],
                 "DATA_SOURCE": "blank",
@@ -43922,6 +43949,7 @@
     },
     "SzEngineReevaluateEntity": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "AFFECTED_ENTITIES": [
                     {
@@ -44574,6 +44602,7 @@
     },
     "SzEngineReevaluateRecord": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "AFFECTED_ENTITIES": [
                     {
@@ -44590,6 +44619,7 @@
     },
     "SzEngineSearchByAttributes": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "RESOLVED_ENTITIES": [],
                 "SEARCH_STATISTICS": [
@@ -46412,11 +46442,12 @@
             "pythonClass": "SzEngineStreamExportJSONEntityReport"
         },
         "tests": {
-            "test-001": {}
+            "test-000": {}
         }
     },
     "SzEngineWhyEntities": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [
                     {
@@ -48063,11 +48094,12 @@
     },
     "SzEngineWhyRecordInEntity": {
         "tests": {
-            "test-001": {}
+            "test-000": {}
         }
     },
     "SzEngineWhyRecords": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "ENTITIES": [],
                 "WHY_RESULTS": [
@@ -51959,6 +51991,7 @@
     },
     "SzProductGetLicense": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "billing": "blank",
                 "contract": "blank",
@@ -51973,6 +52006,7 @@
     },
     "SzProductGetVersion": {
         "tests": {
+            "test-000": {},
             "test-001": {
                 "BUILD_DATE": "blank",
                 "BUILD_NUMBER": "blank",

diff --git a/doc.go b/doc.go
@@ -1,5 +1,5 @@
 /*
-The Senzing sz-sdk-go packages contain interface definitions for the Senzing Go SDK.
+Module sz-sdk-go contains interface definitions for the Senzing Go SDK.
 
 # Synopsis
 

diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.21
 
 require (
 	github.com/aquilax/truncate v1.0.0
-	github.com/senzing-garage/sz-sdk-json-type-definition v0.2.6
+	github.com/senzing-garage/sz-sdk-json-type-definition v0.2.7
 	github.com/stretchr/testify v1.9.0
 )
 

diff --git a/go.sum b/go.sum
@@ -16,8 +16,8 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
-github.com/senzing-garage/sz-sdk-json-type-definition v0.2.6 h1:306hNQumqaZ5Ge2aKdEMueKJ2KCSHh5WC5cs2EOdMRQ=
-github.com/senzing-garage/sz-sdk-json-type-definition v0.2.6/go.mod h1:UlKL1vflvcE8rNOpbptlNiw57SixFAUWk5ftu5gHL9Y=
+github.com/senzing-garage/sz-sdk-json-type-definition v0.2.7 h1:Sv0CMHPWaF8Jq+VBi56iDbBFeh/rfiGsiFOaAGZ2V4U=
+github.com/senzing-garage/sz-sdk-json-type-definition v0.2.7/go.mod h1:UlKL1vflvcE8rNOpbptlNiw57SixFAUWk5ftu5gHL9Y=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

diff --git a/response/response.go b/response/response.go
@@ -43,9 +43,9 @@ func SzConfigManagerGetConfig(ctx context.Context, jsonString string) (*typedef.
 	return result, err
 }
 
-func SzConfigManagerGetConfigList(ctx context.Context, jsonString string) (*typedef.SzConfigManagerGetConfigListResponse, error) {
+func SzConfigManagerGetConfigs(ctx context.Context, jsonString string) (*typedef.SzConfigManagerGetConfigsResponse, error) {
 	_ = ctx
-	result := &typedef.SzConfigManagerGetConfigListResponse{}
+	result := &typedef.SzConfigManagerGetConfigsResponse{}
 	err := json.Unmarshal([]byte(jsonString), result)
 	return result, err
 }

diff --git a/response/response_test.go b/response/response_test.go