TESTING: parse_tests files should be uniformly formatted and sorted

pkg/js/README-parse_tests.md

@@ -0,0 +1,42 @@
+
+# Parse Tests
+
+The `parse_tests` directory contains test cases for `js_test.go`.  `js_test.go`
+scans for files named `DDD-*.js` where `DDD` is a three-digit number.
+
+* `parse_tests/001-basic.js`  -- The dnsconfig.js file.
+* `parse_tests/001-basic.json` -- The EXPECTED output of "print-ir" for the `.js` file.
+* `parse_tests/001-basic.json.ACTUAL` -- The ACTUAL output of "print-ir" for the `.js` file (not saved in git)
+* `parse_tests/001-basic/foo.com.zone` -- Zonefiles from the domains mentioned in dnsconfig.js
+
+NOTE: The zonefiles are only tested if a matching `DDD-name/DOMAINNAME.zone` file exists.
+
+Any files committed to Git should be in standard format.
+
+# Fix formatting
+
+Fix the `.js` formatting:
+
+```
+cd parse_tests
+for i in *.js ; do echo ========== $i ; dnscontrol fmt -i $i -o $i ; done
+```
+
+Fix the `.json` formatting:
+
+```
+cd parse_tests
+fmtjson *.json *.json.ACTUAL
+```
+
+# Copy actuals to expected.
+
+Back-port the ACTUAL results to the expected results:
+
+(This is dangerous. You may be committing buggy results to the "expected" files. Carefully inspect the resulting PR.)
+
+```
+cd parse_tests
+fmtjson *.json *.json.ACTUAL
+for i in *.ACTUAL ; do f=$(basename $i .ACTUAL) ; cp $i $f ; done
+```

pkg/js/js_test.go

@@ -9,6 +9,7 @@ import (
 	"testing"
 	"unicode"
 
+	"github.com/StackExchange/dnscontrol/v4/models"
 	"github.com/StackExchange/dnscontrol/v4/pkg/normalize"
 	"github.com/StackExchange/dnscontrol/v4/pkg/prettyzone"
 	"github.com/StackExchange/dnscontrol/v4/providers"
@@ -49,6 +50,21 @@ func TestParsedFiles(t *testing.T) {
 			// 	normalize.UpdateNameSplitHorizon(dc)
 			// }
 
+			errs := normalize.ValidateAndNormalizeConfig(conf)
+			if len(errs) != 0 {
+				t.Fatal(errs[0])
+			}
+
+			for _, dc := range conf.Domains {
+				//fmt.Printf("DEBUG: PrettySort: domain=%q #rec=%d\n", dc.Name, len(dc.Records))
+				//fmt.Printf("DEBUG: records = %d %v\n", len(dc.Records), dc.Records)
+				ps := prettyzone.PrettySort(dc.Records, dc.Name, 0, nil)
+				dc.Records = ps.Records
+				if len(dc.Records) == 0 {
+					dc.Records = models.Records{}
+				}
+			}
+
 			// Initialize any DNS providers mentioned.
 			for _, dProv := range conf.DNSProviders {
 				var pcfg = map[string]string{}
@@ -91,11 +107,6 @@ func TestParsedFiles(t *testing.T) {
 
 			// For each domain, if there is a zone file, test against it:
 
-			errs := normalize.ValidateAndNormalizeConfig(conf)
-			if len(errs) != 0 {
-				t.Fatal(errs[0])
-			}
-
 			var dCount int
 			for _, dc := range conf.Domains {
 				zoneFile := filepath.Join(testDir, testName, dc.Name+".zone")

pkg/js/parse_tests/001-basic.js

@@ -1,7 +1,6 @@
-
-var REG = NewRegistrar("Third-Party","NONE");
+var REG = NewRegistrar("Third-Party", "NONE");
 var CF = NewDnsProvider("Cloudflare", "CLOUDFLAREAPI");
 
-D("foo.com",REG,DnsProvider(CF),
-    A("@","1.2.3.4")
-);
+D("foo.com", REG, DnsProvider(CF),
+    A("@", "1.2.3.4")
+);

pkg/js/parse_tests/001-basic.json

@@ -1,30 +1,35 @@
 {
-    "registrars": [
+  "dns_providers": [
+    {
+      "name": "Cloudflare",
+      "type": "CLOUDFLAREAPI"
+    }
+  ],
+  "domains": [
+    {
+      "dnsProviders": {
+        "Cloudflare": -1
+      },
+      "meta": {
+        "dnscontrol_tag": "",
+        "dnscontrol_uniquename": "foo.com"
+      },
+      "name": "foo.com",
+      "records": [
         {
-            "name": "Third-Party",
-            "type": "NONE"
+          "name": "@",
+          "target": "1.2.3.4",
+          "ttl": 300,
+          "type": "A"
         }
-    ],
-    "dns_providers": [
-        {
-            "name": "Cloudflare",
-            "type": "CLOUDFLAREAPI"
-        }
-    ],
-    "domains": [
-        {
-            "name": "foo.com",
-            "registrar": "Third-Party",
-            "dnsProviders": {
-                "Cloudflare": -1
-            },
-            "records": [
-                {
-                    "type": "A",
-                    "name": "@",
-                    "target": "1.2.3.4"
-                }
-            ]
-        }
-    ]
+      ],
+      "registrar": "Third-Party"
+    }
+  ],
+  "registrars": [
+    {
+      "name": "Third-Party",
+      "type": "NONE"
+    }
+  ]
 }

pkg/js/parse_tests/002-ttl.js

@@ -1,5 +1,6 @@
-var REG = NewRegistrar("Third-Party","NONE");
-var CF = NewDnsProvider("Cloudflare", "CLOUDFLAREAPI")
-D("foo.com",REG,DnsProvider(CF),
-    A("@","1.2.3.4",TTL(42))
-);
+var REG = NewRegistrar("Third-Party", "NONE");
+var CF = NewDnsProvider("Cloudflare", "CLOUDFLAREAPI");
+
+D("foo.com", REG, DnsProvider(CF),
+    A("@", "1.2.3.4", TTL(42)),
+);

pkg/js/parse_tests/002-ttl.json

@@ -1,10 +1,4 @@
 {
-  "registrars": [
-    {
-      "name": "Third-Party",
-      "type": "NONE"
-    }
-  ],
   "dns_providers": [
     {
       "name": "Cloudflare",
@@ -13,19 +7,29 @@
   ],
   "domains": [
     {
-      "name": "foo.com",
-      "registrar": "Third-Party",
       "dnsProviders": {
         "Cloudflare": -1
       },
+      "meta": {
+        "dnscontrol_tag": "",
+        "dnscontrol_uniquename": "foo.com"
+      },
+      "name": "foo.com",
       "records": [
         {
-          "type": "A",
           "name": "@",
           "target": "1.2.3.4",
-          "ttl": 42
+          "ttl": 42,
+          "type": "A"
         }
-      ]
+      ],
+      "registrar": "Third-Party"
+    }
+  ],
+  "registrars": [
+    {
+      "name": "Third-Party",
+      "type": "NONE"
     }
   ]
 }

pkg/js/parse_tests/003-meta.js

@@ -1,5 +1,7 @@
+var CLOUDFLARE = NewRegistrar("Cloudflare", "CLOUDFLAREAPI");
 
-var CLOUDFLARE = NewRegistrar("Cloudflare","CLOUDFLAREAPI");
-D("foo.com",CLOUDFLARE,
-    A("@","1.2.3.4",{"cloudflare_proxy":"ON"})
-);
+D("foo.com", CLOUDFLARE,
+    A("@", "1.2.3.4", {
+        "cloudflare_proxy": "ON"
+    }),
+);

pkg/js/parse_tests/003-meta.json

@@ -1,26 +1,31 @@
 {
-  "registrars": [
-    {
-      "name": "Cloudflare",
-      "type": "CLOUDFLAREAPI"
-    }
-  ],
   "dns_providers": [],
   "domains": [
     {
-      "name": "foo.com",
-      "registrar": "Cloudflare",
       "dnsProviders": {},
+      "meta": {
+        "dnscontrol_tag": "",
+        "dnscontrol_uniquename": "foo.com"
+      },
+      "name": "foo.com",
       "records": [
         {
-          "type": "A",
-          "name": "@",
-          "target": "1.2.3.4",
           "meta": {
             "cloudflare_proxy": "ON"
-          }
+          },
+          "name": "@",
+          "target": "1.2.3.4",
+          "ttl": 300,
+          "type": "A"
         }
-      ]
+      ],
+      "registrar": "Cloudflare"
+    }
+  ],
+  "registrars": [
+    {
+      "name": "Cloudflare",
+      "type": "CLOUDFLAREAPI"
     }
   ]
 }

pkg/js/parse_tests/004-ips.js

@@ -1,10 +1,10 @@
-var REG = NewRegistrar("Third-Party","NONE");
-var CF = NewDnsProvider("Cloudflare", "CLOUDFLAREAPI")
+var REG = NewRegistrar("Third-Party", "NONE");
+var CF = NewDnsProvider("Cloudflare", "CLOUDFLAREAPI");
 
-var BASE = IP("1.2.3.4")
+var BASE = IP("1.2.3.4");
 
-D("foo.com",REG,DnsProvider(CF,0),
-    A("@",BASE),
-    A("p1",BASE+1),
-    A("p255", BASE+255)
-);
+D("foo.com", REG, DnsProvider(CF, 0),
+    A("@", BASE),
+    A("p1", BASE + 1),
+    A("p255", BASE + 255),
+);

pkg/js/parse_tests/004-ips.json

@@ -1,10 +1,4 @@
 {
-  "registrars": [
-    {
-      "name": "Third-Party",
-      "type": "NONE"
-    }
-  ],
   "dns_providers": [
     {
       "name": "Cloudflare",
@@ -13,28 +7,41 @@
   ],
   "domains": [
     {
-      "name": "foo.com",
-      "registrar": "Third-Party",
       "dnsProviders": {
         "Cloudflare": 0
       },
+      "meta": {
+        "dnscontrol_tag": "",
+        "dnscontrol_uniquename": "foo.com"
+      },
+      "name": "foo.com",
       "records": [
         {
-          "type": "A",
           "name": "@",
-          "target": "1.2.3.4"
+          "target": "1.2.3.4",
+          "ttl": 300,
+          "type": "A"
         },
         {
-          "type": "A",
           "name": "p1",
-          "target": "1.2.3.5"
+          "target": "1.2.3.5",
+          "ttl": 300,
+          "type": "A"
         },
         {
-          "type": "A",
           "name": "p255",
-          "target": "1.2.4.3"
+          "target": "1.2.4.3",
+          "ttl": 300,
+          "type": "A"
         }
-      ]
+      ],
+      "registrar": "Third-Party"
+    }
+  ],
+  "registrars": [
+    {
+      "name": "Third-Party",
+      "type": "NONE"
     }
   ]
 }