Using the Test Factory

[thomask5]

I'm on orchid-orm v1.40.1 with associated downstream dependencies and trying to use the Test Factory for my unit tests.

When using Test Factory, I'm getting the error:
Don't know how to generate data for column test.example_id that has no as

I have tried with both factory.test.build() and factory.test.create() and get the same error.

I am able to directly call db.test.create() just fine, but would love to use factory in some other test where any data will work and would appreciate any help in getting the test factory working.

I have created a table that looks like:

export class Example extends BaseTable {
  readonly table = 'example';
  columns = this.setColumns((t) => ({
    example_id: t.id('example'),
    connection_id: t.text(),
    name: t.text(),
    parameter: t.text(),
    data_value: t.text(),
    created_at: t.timestampNoTZ().default('now()').nullable(),
    updated_at: t.timestampNoTZ().nullable(), // Updated with trigger
  }));
}

In my unit test I have:

import { ormFactory } from 'orchid-orm-test-factory';
import { db } from 'shared/orm/db';

const factory = ormFactory(db);

describe('example test', () => {

  beforeEach() => {
    // Create some unrelated mocks for req, res
  }
  
  afterEach(() => {
    jest.clearAllMocks();
  });

  describe('GET Requests', () => {
    it('should return only selected financial codes when only_selected is true', async () => {
      req.method = HttpMethod.GET;

      await factory.test.createMany(
        {
          connection_id: CONNECTION_ID,
          name: NAME,
          parameter: 'parameter_1',
          data_value: 'test_parameter_1',
        },
        {
          connection_id: CONNECTION_ID,
          name: NAME,
          parameter: 'parameter_2',
          data_value: JSON.stringify('parameter_2'),
        },
      );

      await api(req, res);
      expect(res.status).toHaveBeenLastCalledWith(200);
    });
  });
});

[romeerez]

The error suggests that there is a suspicious test_id column, are you sure there is no such column (maybe testId) in your codebase?

[thomask5]

My apologies, it is referring to example_id which is a column in the code base and defined as shown above.

[romeerez]

I see, so the test factory generates data based on column types: random number for int, random text for varchar, but it doesn't know how to generate data for your t.id because it is a custom type.

You can add .as(t.string()), to the definition of the shared id column, and test factory would generate a random string.

Another option: you can configure test factory for this specific table to generate data for id as needed, here is a doc.

This isn't ideal because it's per table, it would be better to define how to generate id just once for all tables, not implemented yet.

[thomask5]

Aww this makes sense. Thanks for the help!

[romeerez]

@thomask5 I also found there is fakeDataForTypes config (you can find it in the same document) to allow configuring generating fake data for various database types.

It may or may not be suitable for your case.

Could you show how is the t.id type defined?

I'm thinking if it worth adding some functionality on top of this to add special identifiers to the custom types on one side, and configuring how to gen fake data on the test factory side.

[thomask5]

@romeerez I'll check out fakeDataForTypes

.id is defined in the BaseTable

import { createBaseTable } from 'orchid-orm';
import { zodSchemaConfig } from 'orchid-orm-schema-to-zod';

export const BaseTable = createBaseTable({
  snakeCase: true,
  schemaConfig: zodSchemaConfig,
  columnTypes: (t) => ({
    ...t,
    id(id_prefix: string) {
      return t
        .text()
        .primaryKey()
        .default(t.sql`concat('${id_prefix}-', gen_random_uuid())`);
    },
  }),
});