suncle1993 / ent-factory

A codegen tool for generating model instance factory based on Ent.

Ent Factory

A Golang Factory Code Generation Command Tool For Ent.

Function

Simplify the process of creating mock model objects for ent schema.

• Auto reading the struct of ent model schemas to create factory functions.
• Auto fake data for each field as default.
• Allow self define the value of any field independently.

Todo

• Auto Format Code
• Support Time Optional Function
• Support Json Field Optional Function
• Code Lint
• CI Add Auto Lint
• Unit Test Coverage
• Version Compatibility Test
• Option param to control overwrite exist factory or not

Struct

-- cmd
    -- root.go
    -- cmd.go
-- constants
    -- constants.go
    -- errors.go
-- main.go
-- README.md

How to install

Install

go install github.com/zaihui/ent-factory@latest

Setup

Flags

• schemaPath
  • path of your entschema, normally is "gen/entschema"
  • required
• outputPath
  • path of your factories
  • the endpoint must be "factories"
  • required
• projectPath
  • the relative path of this project
  • eg. github.com/zaihui/ent-factory
  • required
• overwrite
  • whether overwrite these exist files
  • the default value is false
• factoriesPath
  • the relative path of these factories located in this project
  • eg. factories, means projectPath/factories
  • the default value is factories
• appPath
  • the relative path of app client
  • eg. service/app means github.com/zaihui/ent-factory/service/app
  • the default value is service/app
• entClientName
  • the name of ent client, means appPath.entClientName
  • the default value is EntClient

Makefile Command

CAUTION!: This Command will NOT regenerate every factory based on the current struct of table.

If you want to Regenerate, please use the overwrite flag. Or delete what you want to regenerate then use this command.

all_factory:
  go run ent-factory generate --schemaPath {your ent schema path} --outputPath {path of your factories} ----projectPath {your project module path}

Sample

all_factory:
  go run ent-factory generate --schemaPath gen/entschema --outputPath  /Users/lvxinyan/zaihui/ent-factory/factories --projectPath github.com/zaihui/ent-factory
## for one factory
ent-factory generate --schemaFile gen/entschema/{one ent model file}.go --outputPath  /Users/lvxinyan/zaihui/ent-factory/factories --projectPath github.com/zaihui/ent-factory

Sample

The sample of a factory

package booktableorderfactory

import (
	"github.com/bxcodec/faker"
	"github/zaihui/ent-factory/factories"
	"github/zaihui/ent-factory/gen/entschema"
	"github/zaihui/ent-factory/service/app"
)

type BookTableOrderFieldSetter func(*entschema.BookTableOrder)


func SetUID(uIDGen string) BookTableOrderFieldSetter {
	return func(bookTableOrderGen *entschema.BookTableOrder) {
		bookTableOrderGen.UID = uIDGen
	}
}

func SetUserUID(userUIDGen string) BookTableOrderFieldSetter {
	return func(bookTableOrderGen *entschema.BookTableOrder) {
		bookTableOrderGen.UserUID = userUIDGen
	}
}
func SetOrderNo(orderNoGen string) BookTableOrderFieldSetter {
	return func(bookTableOrderGen *entschema.BookTableOrder) {
		bookTableOrderGen.OrderNo = orderNoGen
	}
}
func SetType(typeGen string) BookTableOrderFieldSetter {
	return func(bookTableOrderGen *entschema.BookTableOrder) {
		bookTableOrderGen.Type = typeGen
	}
}

func New(s factories.TestSuite, opts ...BookTableOrderFieldSetter) *entschema.BookTableOrder {
	data := entschema.BookTableOrder{}
	s.NoError(faker.FakeData(&data))
	for _, opt := range opts {
		opt(&data)
	}
	return app.EntClient.BookTableOrder.Create().
		SetUID(data.UID).
		SetUserUID(data.UserUID).
		SetOrderNo(data.OrderNo).
		SetType(data.Type).
		SaveX(s.Context())
}

How to use this factory

package main
import (
	your_location_of_factories/booktableorderfactory
)
// s is an instance of test suite
booktableorderfactory.new(s) 
// if you want to customize the value of a field, eg. UID
booktableorderfactory.new(s, booktableorderfactory.SetUID("your uid"))

Special Thank

Special Thanks splunk. The part of codegen about function optional pattern is based on this project from splunk.

I edit some logic of it to implement my need, so I haven't imported it as a package to use it.