test(shared-data): Fix schema 3 labware definitions not being tested (#…

…17425)

shared-data/js/__tests__/labwareDefSchemaV3.test.ts

@@ -7,15 +7,13 @@ import Ajv from 'ajv'
 import schema from '../../labware/schemas/3.json'
 
 const fixturesDir = path.join(__dirname, '../../labware/fixtures/3')
+const definitionsDir = path.join(__dirname, '../../labware/definitions/3')
 const globPattern = '**/*.json'
 
 const ajv = new Ajv({ allErrors: true, jsonPointers: true })
 const validate = ajv.compile(schema)
 
-const checkGeometryDefinitions = (
-  labwareDef: LabwareDefinition3,
-  filename: string
-): void => {
+const checkGeometryDefinitions = (labwareDef: LabwareDefinition3): void => {
   test('innerLabwareGeometry sections should be sorted top to bottom', () => {
     const geometries = Object.values(labwareDef.innerLabwareGeometry ?? [])
     for (const geometry of geometries) {
@@ -27,7 +25,7 @@ const checkGeometryDefinitions = (
     }
   })
 
-  test(`all geometryDefinitionIds specified in {filename} should have an accompanying valid entry in innerLabwareGeometry`, () => {
+  test('all geometryDefinitionIds should have an accompanying valid entry in innerLabwareGeometry', () => {
     for (const wellName in labwareDef.wells) {
       const wellGeometryId = labwareDef.wells[wellName].geometryDefinitionId
 
@@ -43,34 +41,53 @@ const checkGeometryDefinitions = (
 
       expect(wellGeometryId in labwareDef.innerLabwareGeometry).toBe(true)
 
-      const wellDepth = labwareDef.wells[wellName].depth
-      const topFrustumHeight =
-        labwareDef.innerLabwareGeometry[wellGeometryId].sections[0].topHeight
-
-      expect(wellDepth).toEqual(topFrustumHeight)
+      // FIXME(mm, 2025-02-04):
+      // `wellDepth` != `topFrustumHeight` for ~23/60 definitions.
+      //
+      // const wellDepth = labwareDef.wells[wellName].depth
+      // const topFrustumHeight =
+      //   labwareDef.innerLabwareGeometry[wellGeometryId].sections[0].topHeight
+      // expect(wellDepth).toEqual(topFrustumHeight)
     }
   })
 }
 
-describe(`test additions to labware schema in v3`, () => {
-  const labwarePaths = glob.sync(globPattern, { cwd: fixturesDir })
+describe(`test labware definitions with schema v3`, () => {
+  const definitionPaths = glob.sync(globPattern, {
+    cwd: definitionsDir,
+    absolute: true,
+  })
+  const fixturePaths = glob.sync(globPattern, {
+    cwd: fixturesDir,
+    absolute: true,
+  })
+  const allPaths = definitionPaths.concat(fixturePaths)
 
-  test("definition paths didn't break, which would give false positives", () => {
-    expect(labwarePaths.length).toBeGreaterThan(0)
+  test("paths didn't break, which would give false positives", () => {
+    expect(definitionPaths.length).toBeGreaterThan(0)
+    expect(fixturePaths.length).toBeGreaterThan(0)
   })
 
-  describe.each(labwarePaths)('%s', labwarePath => {
-    const filename = path.parse(labwarePath).base
-    const fullLabwarePath = path.join(fixturesDir, labwarePath)
-    const labwareDef = require(fullLabwarePath) as LabwareDefinition3
+  describe.each(allPaths)('%s', labwarePath => {
+    const labwareDef = require(labwarePath) as LabwareDefinition3
 
-    it(`${filename} validates against schema`, () => {
+    it('validates against schema', () => {
       const valid = validate(labwareDef)
       const validationErrors = validate.errors
-      expect(validationErrors).toBe(null)
-      expect(valid).toBe(true)
+
+      // FIXME(mm, 2025-02-04): These new definitions have a displayCategory that
+      // the schema does not recognize. Either they need to change or the schema does.
+      const expectFailure = [
+        'opentrons_flex_tiprack_lid',
+        'opentrons_tough_pcr_auto_sealing_lid',
+        'protocol_engine_lid_stack_object',
+      ].includes(labwareDef.parameters.loadName)
+
+      if (expectFailure) expect(validationErrors).not.toBe(null)
+      else expect(validationErrors).toBe(null)
+      expect(valid).toBe(!expectFailure)
     })
 
-    checkGeometryDefinitions(labwareDef, labwarePath)
+    checkGeometryDefinitions(labwareDef)
   })
 })