Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*: Add testfork.RunTest to run multiple tests in one function #35746

Merged
merged 8 commits into from
Jun 28, 2022

Conversation

lcwangchao
Copy link
Collaborator

@lcwangchao lcwangchao commented Jun 27, 2022

What problem does this PR solve?

Issue Number: close #35747

What is changed and how it works?

Some times we want to do a series of tests and all the them are similar except for some parameters. For example:

	for _, autocommit := range []bool{false, true} {
		for _, isolation := range []string{"READ-COMMITTED", "REPEATABLE-READ"} {
			t.Run("", func(t *testing.T) {
				tk := testkit.NewTestKit(t, store)
				tk.MustExec(fmt.Sprintf("set tx_isolation = '%s'", isolation)
				tk.MustExec(fmt.Sprintf("set autocommit=%d", autocommit))
				tk.MustExec("insert into t values(1, 2)")
				tk.MustQuery("select * from t where id=1").Check(testkit.Rows("1 2"))
			})
		}
	}

The above test will generate 4 sub tests and each of them will test one combination of isolation and autcommit settings. However, the implement is very elegant because the "for loops" are nested. When we have more and more parameters to composite, we will get a very deep syntax tree.

This PR provide a new method testfork.RunTest to simplify the above cases, for example, the above test codes can be like this:

	testfork.RunTest(t, func(t *testfork.T) {
		tk := testkit.NewTestKit(t, store)
		isolation := testfork.PickEnum(t, "READ-COMMITTED", "REPEATABLE-READ")
		tk.MustExec(fmt.Sprintf("set tx_isolation = '%s'", isolation))
		autocommit := testfork.PickEnum(t, 1, 0)
		tk.MustExec(fmt.Sprintf("set autocommit=%d", autocommit))
		tk.MustExec("insert into t values(1, 2)")
		tk.MustQuery("select * from t where id=1").Check(testkit.Rows("1 2"))
	})

When we call Pick or PickEnum in a function, the test will "fork" to several sub tests according to the candidate values passed to it. Pick or PickEnum can be called multiple times in a function, and it will "fork" multiple times if you do it.

It also support conditional fork, for example:

	testfork.RunTest(t, func(t *testfork.T) {
		tk := testkit.NewTestKit(t, store)
		if pessimistic := testfork.PickEnum(t, true, false); pessimistic {
			isolation := testfork.PickEnum(t, "READ-COMMITTED", "REPEATABLE-READ")
			tk.MustExec(fmt.Sprintf("set tx_isolation = '%s'", isolation))
		}

		autocommit := testfork.PickEnum(t, 1, 0)
		tk.MustExec(fmt.Sprintf("set autocommit=%d", autocommit))
		tk.MustExec("insert into t values(1, 2)")
		tk.MustQuery("select * from t where id=1").Check(testkit.Rows("1 2"))
	})

In the above demo tx_siolation will only be forked and set when pessimistic is true (it is also a forked value and can be different in different sub tests).

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Jun 27, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • bb7133
  • tiancaiamao

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added do-not-merge/needs-linked-issue release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 27, 2022
@sre-bot
Copy link
Contributor

sre-bot commented Jun 27, 2022

Please follow PR Title Format:

  • pkg [, pkg2, pkg3]: what is changed

Or if the count of mainly changed packages are more than 3, use

  • *: what is changed

After you have format title, you can leave a comment /run-check_title to recheck it

@lcwangchao lcwangchao changed the title Add testfork.RunTest to run multiple test in one function *: Add testfork.RunTest to run multiple test in one function Jun 27, 2022
@lcwangchao lcwangchao changed the title *: Add testfork.RunTest to run multiple test in one function *: Add testfork.RunTest to run multiple tests in one function Jun 27, 2022
@sre-bot
Copy link
Contributor

sre-bot commented Jun 27, 2022

Copy link
Contributor

@tiancaiamao tiancaiamao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You code make me think of a old joke:
"what's the biggest hinder that prevent functional programming language from being popular?"
The answer is:
"we don't get enough "clever" programmers. That's the biggest hinder and it's insoluble."

The code itself is clever, but I can't claim this developing philosophy as wise.
Stupid simple code is the real wisdom for the averages.

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Jun 28, 2022
@lcwangchao
Copy link
Collaborator Author

You code make me think of a old joke:

"what's the biggest hinder that prevent functional programming language from being popular?"
The answer is:
"we don't get enough "clever" programmers. That's the biggest hinder and it's insoluble."
The code itself is clever, but I can't claim this developing philosophy as wise. Stupid simple code is the real wisdom for the averages.

I agree with you with some of the opinions. But I think the key point is "only use it when it is necessary". "Necessary" means it can reduce the implement complex a lot when use it. I don't think it's a good practice to apply the FP to the whole project, but they can work better in some certain cases for example: react UI. Whether to use it or not can be determined by the developer.

Copy link
Member

@bb7133 bb7133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Jun 28, 2022
@bb7133
Copy link
Member

bb7133 commented Jun 28, 2022

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 374bee1

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jun 28, 2022
@lcwangchao
Copy link
Collaborator Author

/rebuild

@lcwangchao
Copy link
Collaborator Author

/rebuild

@lcwangchao
Copy link
Collaborator Author

/run-check_dev_2

@lcwangchao
Copy link
Collaborator Author

/run-mysql-test

@ti-chi-bot ti-chi-bot merged commit 0d9e02b into pingcap:master Jun 28, 2022
@lcwangchao lcwangchao deleted the forkrun branch June 28, 2022 09:14
@sre-bot
Copy link
Contributor

sre-bot commented Jun 28, 2022

TiDB MergeCI notify

🔴 Bad News! New failing [1] after this pr merged.
These new failed integration tests seem to be caused by the current PR, please try to fix these new failed integration tests, thanks!

CI Name Result Duration Compare with Parent commit
idc-jenkins-ci-tidb/integration-ddl-test 🟥 failed 1, success 5, total 6 14 min New failing
idc-jenkins-ci-tidb/integration-common-test 🔴 failed 2, success 9, total 11 27 min Existing failure
idc-jenkins-ci-tidb/common-test ✅ all 12 tests passed 9 min 33 sec Fixed
idc-jenkins-ci/integration-cdc-test 🟢 all 35 tests passed 30 min Existing passed
idc-jenkins-ci-tidb/sqllogic-test-2 🟢 all 28 tests passed 7 min 32 sec Existing passed
idc-jenkins-ci-tidb/sqllogic-test-1 🟢 all 26 tests passed 6 min 52 sec Existing passed
idc-jenkins-ci-tidb/tics-test 🟢 all 1 tests passed 6 min 6 sec Existing passed
idc-jenkins-ci-tidb/integration-compatibility-test 🟢 all 1 tests passed 3 min 33 sec Existing passed
idc-jenkins-ci-tidb/mybatis-test 🟢 all 1 tests passed 2 min 52 sec Existing passed
idc-jenkins-ci-tidb/plugin-test 🟢 build success, plugin test success 4min Existing passed

morgo added a commit to morgo/tidb that referenced this pull request Jun 28, 2022
* upstream/master: (57 commits)
  types: fix incompatible implementation of jsonpath extraction (pingcap#35320)
  planner: fix TRACE PLAN TARGET = 'estimation' panic when meeting partition table (pingcap#35743)
  *: Add `testfork.RunTest` to run multiple tests in one function (pingcap#35746)
  sessionctx/variable: add tests to ensure skipInit can be removed (pingcap#35703)
  helper: request another PD if one of them is unavailable (pingcap#35750)
  metrics: add cached table related metrics to grafana panel (pingcap#34718)
  expression: use cloned RetType at `evaluateExprWithNull` when it may be changed. (pingcap#35759)
  executor: fix left join on partition table generate invalid lock key (pingcap#35732)
  readme: remove adopters (pingcap/docs#8725) (pingcap#35124)
  *: only add default value for final aggregation to fix the aggregate push down (partition) union case (pingcap#35443)
  planner: fix the wrong cost formula of MPPExchanger on cost model ver2 (pingcap#35718)
  sessionctx: support encoding and decoding statement context (pingcap#35688)
  txn: refactor ts acquisition within build and execute phases (pingcap#35376)
  ddl: for schema-level DDL method parameter is now XXXStmt (pingcap#35722)
  *: enable gofmt (pingcap#35721)
  planner: disable collate clause support for enum or set column (pingcap#35684)
  *: Provide a util to "pause" session in uint test (pingcap#35529)
  ddl: implement the core for multi-schema change (pingcap#35429)
  parser: XXXDatabaseStmt now use CIStr for DB name (pingcap#35668)
  *: remove real tikv test on github actions (pingcap#35710)
  ...
morgo added a commit to morgo/tidb that referenced this pull request Jun 29, 2022
…vars

* upstream/master: (28 commits)
  *: enable unconvert (pingcap#35821)
  log-backup: check timezone when using datatime format ts string (pingcap#35811)
  planner: support the leading hint for outer join (pingcap#35264)
  lightning: revert new policy of allocating rowid and refine it later (pingcap#35817)
  txn: manage the initialization of RCCheckTS by transaction context provider (pingcap#35554)
  ddl: make output field name in `show tables/databases stmt` compatible with mysql (pingcap#35136)
  txn: remove `legacy.SimpleTxnContextProvider` (pingcap#35667)
  txn: fix the error message if retry could not be used for rc check ts (pingcap#35474)
  *: support canceling DDL statements with KILL (pingcap#35803)
  lightning: avoid extracting db schema when schema file is not provided (pingcap#35783)
  *: enable all gosimples (pingcap#35762)
  tools/check: skip 'tests' directory in 'make ut' (pingcap#35800)
  metrics: add loading region cache duration (pingcap#34679)
  ddl: DROP TABLE/VIEW/SEQUENCE now use XXXStmt as parameter (pingcap#35741)
  types: fix incompatible implementation of jsonpath extraction (pingcap#35320)
  planner: fix TRACE PLAN TARGET = 'estimation' panic when meeting partition table (pingcap#35743)
  *: Add `testfork.RunTest` to run multiple tests in one function (pingcap#35746)
  sessionctx/variable: add tests to ensure skipInit can be removed (pingcap#35703)
  helper: request another PD if one of them is unavailable (pingcap#35750)
  metrics: add cached table related metrics to grafana panel (pingcap#34718)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add testfork.RunTest to run multiple test in one function
5 participants