[#156] Trim redundant config fields from test configs

Problem: In #159 we made all config fields optional. Now we can trim redundant fields from test configs. Solution: Trim redundant config fields. Also slightly refactor `overrideVerify` function to make it more readable.
serokell · Sep 25, 2022 · 24ea5a9 · 24ea5a9
1 parent 31777f7
commit 24ea5a9
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 142 deletions.
diff --git a/src/Xrefcheck/Config.hs b/src/Xrefcheck/Config.hs
@@ -225,23 +225,18 @@ overrideConfig config
 
     overrideVerify verifyConfig
       = VerifyConfig
-        { vcAnchorSimilarityThreshold = fromMaybe (vcAnchorSimilarityThreshold defVerification)
-            $ vcAnchorSimilarityThreshold verifyConfig
-        , vcExternalRefCheckTimeout   = fromMaybe (vcExternalRefCheckTimeout defVerification)
-            $ vcExternalRefCheckTimeout verifyConfig
-        , vcVirtualFiles              = fromMaybe (vcVirtualFiles defVerification)
-            $ vcVirtualFiles verifyConfig
-        , vcNotScanned                = fromMaybe (vcNotScanned defVerification)
-            $ vcNotScanned verifyConfig
-        , vcIgnoreRefs                = fromMaybe (vcIgnoreRefs defVerification)
-            $ vcIgnoreRefs verifyConfig
-        , vcIgnoreAuthFailures        = fromMaybe (vcIgnoreAuthFailures defVerification)
-            $ vcIgnoreAuthFailures verifyConfig
-        , vcDefaultRetryAfter         = fromMaybe (vcDefaultRetryAfter defVerification)
-            $ vcDefaultRetryAfter verifyConfig
-        , vcMaxRetries                = fromMaybe (vcMaxRetries defVerification)
-            $ vcMaxRetries verifyConfig
+        { vcAnchorSimilarityThreshold = overrideField vcAnchorSimilarityThreshold
+        , vcExternalRefCheckTimeout   = overrideField vcExternalRefCheckTimeout
+        , vcVirtualFiles              = overrideField vcVirtualFiles
+        , vcNotScanned                = overrideField vcNotScanned
+        , vcIgnoreRefs                = overrideField vcIgnoreRefs
+        , vcIgnoreAuthFailures        = overrideField vcIgnoreAuthFailures
+        , vcDefaultRetryAfter         = overrideField vcDefaultRetryAfter
+        , vcMaxRetries                = overrideField vcMaxRetries
         }
+      where
+        overrideField :: (forall f. VerifyConfig' f -> Field f a) -> a
+        overrideField field = fromMaybe (field defVerification) $ field verifyConfig
 
 -----------------------------------------------------------
 -- Yaml instances

diff --git a/tests/golden/check-cli/config-no-scan-ignored.yaml b/tests/golden/check-cli/config-no-scan-ignored.yaml
@@ -2,19 +2,5 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
   notScanned: [ "to-ignore/broken-link.md" ]
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-ignoreRefs/config-check-disabled.yaml b/tests/golden/check-ignoreRefs/config-check-disabled.yaml
@@ -2,20 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
-  notScanned: []
-  virtualFiles: []
   ignoreRefs:
     - ^(https?|ftps?)://(localhost|127\.0\.0\.1).*
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-ignoreRefs/config-check-enabled.yaml b/tests/golden/check-ignoreRefs/config-check-enabled.yaml
@@ -2,19 +2,5 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
-  notScanned: []
-  virtualFiles: []
   ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-ignored/config-ignored.yaml b/tests/golden/check-ignored/config-ignored.yaml
@@ -5,17 +5,3 @@
 traversal:
   ignored:
     - ./to-ignore/inner-directory/broken_annotation.md
-
-verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
-  notScanned: []
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-notScanned/config-directory.yaml b/tests/golden/check-notScanned/config-directory.yaml
@@ -2,20 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
   notScanned:
     - notScanned/inner-directory
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-notScanned/config-full-path.yaml b/tests/golden/check-notScanned/config-full-path.yaml
@@ -2,20 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
   notScanned:
     - ./notScanned/inner-directory/bad-reference.md
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-notScanned/config-nested-directories.yaml b/tests/golden/check-notScanned/config-nested-directories.yaml
@@ -2,20 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
   notScanned:
     - ./**/*
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-notScanned/config-wildcard.yaml b/tests/golden/check-notScanned/config-wildcard.yaml
@@ -2,20 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
   notScanned:
     - ./notScanned/inner-directory/*
-  virtualFiles: []
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub
diff --git a/tests/golden/check-virtualFiles/config-virtualFiles.yaml b/tests/golden/check-virtualFiles/config-virtualFiles.yaml
@@ -2,22 +2,8 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-traversal:
-  ignored: []
-
 verification:
-  anchorSimilarityThreshold: 0.5
-  externalRefCheckTimeout: 10s
-  notScanned: []
   virtualFiles:
     - ./one/a.md
     - ./two/*
     - ./three/**/*
-  ignoreRefs: []
-  ignoreAuthFailures: true
-  defaultRetryAfter: 30s
-  maxRetries: 3
-
-scanners:
-  markdown:
-    flavor: GitHub