polishing upt the api for prod. added validator to ensure json responses match prod responses

Author: amyfromandi

api-tests/app.ts

@@ -8,13 +8,13 @@ import * as fs from 'fs';
 import * as path from 'path';
 
 
-const testFiles = [
+const endpointsToFix = [
     //can't find the gmna.lookup_units table. 'geologic_units_gmna.ts',
     //'geologic_units_gmus.ts'
     //'mancos_test_cases.ts',
     //uses gmus.lookup_units table. queries need to be customized and changed to match all of the lookup tables within postgresql 'mobile_point_details.ts;
 ]
-/*
+const testFiles = [
  'carto_small.ts',
     'columns.ts',
     'defs.ts',
@@ -37,21 +37,19 @@ const testFiles = [
     'defs_timescales.ts',
     'fossils.ts',
     'geologic_units_burwell.ts',
-    'geologic_units_gmna.ts',
-    'geologic_units_gmus.ts',
     'index.ts',
-    'mancos_test_cases.ts',
     'mobile_fossil_collections.ts',
     'mobile_macro_summary.ts',
     'mobile_map_query.ts',
     'mobile_point.ts',
     'mobile_point_details.ts',
-    'paleogeography.ts',
+    /*'paleogeography.ts',
     'root.ts',
-    'sections.ts',
-    'stats.ts',
-    'tiles.ts',
- */
+    'sections.ts',*/
+    'stats.ts' ]
+    //'tiles.ts'
+
+
 const testDir = path.join(__dirname, 'v2Tests');
 
 testFiles.forEach((file) => {

api-tests/package-lock.json

@@ -8,6 +8,7 @@
     "test": "mocha -r ts-node/register app.ts"
   },
   "dependencies": {
+    "axios": "^1.7.9",
     "express": "^5.0.0",
     "mocha": "^9.0.0",
     "supertest": "^6.1.3"

api-tests/package.json

@@ -2,100 +2,83 @@ var request = require("supertest"),
 validators = require("../validators"),
 settings = require("../settings");
 
-it("should return metadata", function (done) {
-request(settings.host)
-  .get("/columns")
-  .expect(validators.aSuccessfulRequest)
-  .expect(validators.json)
-  .expect(validators.metadata)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+it("should return metadata", async function () {
+  const localResponse = await request(settings.host)
+    .get("/columns")
+    .expect(validators.aSuccessfulRequest)
+    .expect(validators.json)
+    .expect(validators.metadata)
+  await validators.compareWithProduction("/columns", localResponse);
 });
 
+
+
+
 //Fixed this test to work on dev and local
-it("should return a sample", function (done) {
-request(settings.host)
-  .get("/columns?sample")
-  .expect(validators.aSuccessfulRequest)
-  .expect(validators.json)
-  .expect(validators.aSample)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+it("should return a sample", async function () {
+  const localResponse = await request(settings.host)
+    .get("/columns?sample")
+    .expect(validators.aSuccessfulRequest)
+    .expect(validators.json)
+    .expect(validators.aSample)
+  await validators.compareWithProduction("/columns?sample", localResponse);
+
 });
 
 //Fixed this test to work on dev and local
-it("should accept an interval name", function (done) {
-request(settings.host)
+it("should accept an interval name", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?interval_name=Permian")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?interval_name=Permian", localResponse)
 });
 
 
-it("should accept an age", function (done) {
-request(settings.host)
+it("should accept an age", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?age=271")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?age=271", localResponse)
 });
 
 
-it("should accept an age_top and age_bottom", function (done) {
-request(settings.host)
+it("should accept an age_top and age_bottom", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?age_top=200&age_bottom=250")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?age_top=200&age_bottom=250", localResponse)
 });
 
 //fixed test in dev and it is now working.
-it("should accept a strat_name parameter", function (done) {
-request(settings.host)
+it("should accept a strat_name parameter", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?strat_name=mancos")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?strat_name=mancos", localResponse)
 });
 
-it("should accept a strat_name_id parameter", function (done) {
-request(settings.host)
+it("should accept a strat_name_id parameter", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?strat_name_id=1205")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?strat_name_id=1205", localResponse)
 });
 
 
 //Checking to see if the rest of the tests below work in prod.
 //count for max number of columns ~50?
-it("should accept a latitude and longitude", function (done) {
-request(settings.host)
+it("should accept a latitude and longitude", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?lat=43.3&lng=-89.3")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
@@ -105,62 +88,45 @@ request(settings.host)
       throw new Error("Columns returning the wrong column for the lat/lng");
     }
   })
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?lat=43.3&lng=-89.3", localResponse)
 });
 
-it("should return topojson", function (done) {
-request(settings.host)
+it("should return topojson", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?age=2&format=topojson")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.topoJSON)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
 });
 
-it("should return csv", function (done) {
-request(settings.host)
+it("should return csv", async function () {
+  const localResponse = await request(settings.host)
   .get("/columns?age=2&format=csv")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.csv)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
 });
 
 
-it("should accept a project_id", function (done) {
+it("should accept a project_id", async function () {
   this.timeout(7000);
-request(settings.host)
+  const localResponse = await request(settings.host)
   .get("/columns?project_id=4")
   .expect(validators.aSuccessfulRequest)
   .expect(validators.json)
   .expect(validators.atLeastOneResult)
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+  await validators.compareWithProduction("/columns?project_id=4", localResponse)
 });
 
-it("should accept a lat/lng and return all adjacent columns", function (done) {
-    request(settings.host)
-  .get("/columns?lat=43.3&lng=-89.3&adjacents=true")
-  .expect(validators.aSuccessfulRequest)
-  .expect(validators.json)
-  .expect(validators.atLeastOneResult)
-  .expect(function (res: { body: { success: { data: string | any[]; }; }; }) {
-    if (res.body.success.data.length != 6) {
-      throw new Error("Wrong number of adjacent columns being returned");
-    }
-  })
-  .end(function (error: any, res: any) {
-    if (error) return done(error);
-    done();
-  });
+it("should accept a lat/lng and return all adjacent columns", async function () {
+  const localResponse = await request(settings.host)
+    .get("/columns?lat=43.3&lng=-89.3&adjacents=true")
+    .expect(validators.aSuccessfulRequest)
+    .expect(validators.json)
+    .expect(validators.atLeastOneResult)
+    .expect(function (res: { body: { success: { data: string | any[]; }; }; }) {
+      if (res.body.success.data.length != 6) {
+        throw new Error("Wrong number of adjacent columns being returned");
+      }
+    })
+  await validators.compareWithProduction("/columns?lat=43.3&lng=-89.3&adjacents=true", localResponse)
 });
 

api-tests/v2Tests/columns.ts

@@ -45,7 +45,7 @@
   });
 
   it("should accept a measurement class", function (done) {
-    this.timeout(5000);
+    this.timeout(9000);
     request(settings.host)
       .get("/defs/measurements?measurement_class=geochemical")
       .expect(validators.aSuccessfulRequest)
@@ -56,7 +56,7 @@
           if (d.class != "geochemical") {
             throw new Error("Wrong measurement class returned");
           }
-        });
+        })
       })
       .end(function (error: any, res: any) {
         if (error) return done(error);

api-tests/v2Tests/defs_measurements.ts

@@ -39,6 +39,7 @@
   });
 
   it("should output CSV", function (done) {
+    this.timeout(9000)
     request(settings.host)
       .get("/defs/strat_name_concepts?all&format=csv")
       .expect(validators.aSuccessfulRequest)

api-tests/v2Tests/defs_strat_name_concepts.ts

@@ -15,6 +15,7 @@
   });
 
   it("should accept a latitude and longitude", function (done) {
+    this.timeout(10000);
     request(settings.host)
       .get("/mobile/macro_summary?lat=43.0706192&lng=-89.406167")
       .expect(validators.aSuccessfulRequest)

api-tests/v2Tests/mobile_macro_summary.ts

@@ -1,4 +1,5 @@
 //var sizeOf = require("image-size");
+const axios = require("axios");
 
 module.exports = {
   aSuccessfulRequest: function (res: { statusCode: number; headers: { [x: string]: string; }; }) {
@@ -154,5 +155,20 @@ module.exports = {
         throw new Error(`t_int_age is not a numeric type: ${item.t_int_age} (type: ${typeof item.t_int_age})`);
       }
     });
+  },
+
+  async compareWithProduction(queryParams = "", localResponse: any) {
+    const prodUrl = `https://www.macrostrat.org/api/v2${queryParams}`;
+    const externalResponse = await axios.get(prodUrl);
+    if (JSON.stringify(localResponse.body) !== JSON.stringify(externalResponse.data)) {
+      throw new Error(
+        `Mismatch for endpoint: ${queryParams}\nLocal: ${JSON.stringify(
+          localResponse.body,
+          null,
+          2
+        )}\nProduction: ${JSON.stringify(externalResponse.data, null, 2)}`
+      );
+    }
   }
 };
+