feat: add vitess-tester workflow

Signed-off-by: Manan Gupta <[email protected]>

.github/workflows/vitess_tester_vtgate.yml

@@ -0,0 +1,159 @@
+# DO NOT MODIFY: THIS FILE IS GENERATED USING "make generate_ci_workflows"
+
+name: Vitess Tester (vtgate)
+on: [push, pull_request]
+concurrency:
+  group: format('{0}-{1}', ${{ github.ref }}, 'Vitess Tester (vtgate)')
+  cancel-in-progress: true
+
+permissions: read-all
+
+env:
+  LAUNCHABLE_ORGANIZATION: "vitess"
+  LAUNCHABLE_WORKSPACE: "vitess-app"
+  GITHUB_PR_HEAD_SHA: "${{ github.event.pull_request.head.sha }}"
+
+jobs:
+  build:
+    name: Run endtoend tests on Vitess Tester (vtgate)
+    runs-on: gh-hosted-runners-4cores-1
+
+    steps:
+    - name: Skip CI
+      run: |
+        if [[ "${{contains( github.event.pull_request.labels.*.name, 'Skip CI')}}" == "true" ]]; then
+          echo "skipping CI due to the 'Skip CI' label"
+          exit 1
+        fi
+
+    - name: Check if workflow needs to be skipped
+      id: skip-workflow
+      run: |
+        skip='false'
+        if [[ "${{github.event.pull_request}}" ==  "" ]] && [[ "${{github.ref}}" != "refs/heads/main" ]] && [[ ! "${{github.ref}}" =~ ^refs/heads/release-[0-9]+\.[0-9]$ ]] && [[ ! "${{github.ref}}" =~ "refs/tags/.*" ]]; then
+          skip='true'
+        fi
+        echo Skip ${skip}
+        echo "skip-workflow=${skip}" >> $GITHUB_OUTPUT
+
+        PR_DATA=$(curl -s\
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          "https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}")
+        draft=$(echo "$PR_DATA" | jq .draft -r)
+        echo "is_draft=${draft}" >> $GITHUB_OUTPUT
+
+    - name: Check out code
+      if: steps.skip-workflow.outputs.skip-workflow == 'false'
+      uses: actions/checkout@v4
+
+    - name: Check for changes in relevant files
+      if: steps.skip-workflow.outputs.skip-workflow == 'false'
+      uses: dorny/[email protected]
+      id: changes
+      with:
+        token: ''
+        filters: |
+          end_to_end:
+            - 'go/**/*.go'
+            - 'go/vt/sidecardb/**/*.sql'
+            - 'go/test/endtoend/onlineddl/vrepl_suite/**'
+            - 'test.go'
+            - 'Makefile'
+            - 'build.env'
+            - 'go.sum'
+            - 'go.mod'
+            - 'proto/*.proto'
+            - 'tools/**'
+            - 'config/**'
+            - 'bootstrap.sh'
+            - '.github/workflows/vitess_tester_vtgate.yml'
+
+    - name: Set up Go
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
+      uses: actions/setup-go@v5
+      with:
+        go-version: 1.22.4
+
+    - name: Set up python
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
+      uses: actions/setup-python@v5
+
+    - name: Tune the OS
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
+      run: |
+        # Limit local port range to not use ports that overlap with server side
+        # ports that we listen on.
+        sudo sysctl -w net.ipv4.ip_local_port_range="22768 65535"
+        # Increase the asynchronous non-blocking I/O. More information at https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_use_native_aio
+        echo "fs.aio-max-nr = 1048576" | sudo tee -a /etc/sysctl.conf
+        sudo sysctl -p /etc/sysctl.conf
+
+    - name: Get dependencies
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
+      run: |
+        # Get key to latest MySQL repo
+        sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys A8D3785C
+        # Setup MySQL 8.0
+        wget -c https://dev.mysql.com/get/mysql-apt-config_0.8.29-1_all.deb
+        echo mysql-apt-config mysql-apt-config/select-server select mysql-8.0 | sudo debconf-set-selections
+        sudo DEBIAN_FRONTEND="noninteractive" dpkg -i mysql-apt-config*
+        sudo apt-get -qq update
+        # Install everything else we need, and configure
+        sudo apt-get -qq install -y mysql-server mysql-client make unzip g++ etcd curl git wget eatmydata xz-utils libncurses5
+
+        sudo service mysql stop
+        sudo service etcd stop
+        sudo ln -s /etc/apparmor.d/usr.sbin.mysqld /etc/apparmor.d/disable/
+        sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.mysqld
+        go mod download
+
+        # install JUnit report formatter
+        go install github.com/vitessio/go-junit-report@HEAD
+        
+        # install vitess tester
+        go install github.com/vitessio/vitess-tester@eb953122baba163ed8ccaa6642458ee984f5d7e4
+
+    - name: Setup launchable dependencies
+      if: steps.skip-workflow.outputs.is_draft == 'false' && steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true' && github.base_ref == 'main'
+      run: |
+        # Get Launchable CLI installed. If you can, make it a part of the builder image to speed things up
+        pip3 install --user launchable~=1.0 > /dev/null
+
+        # verify that launchable setup is all correct.
+        launchable verify || true
+
+        # Tell Launchable about the build you are producing and testing
+        launchable record build --name "$GITHUB_RUN_ID" --no-commit-collection --source .
+
+    - name: Run cluster endtoend test
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
+      timeout-minutes: 45
+      run: |
+        # We set the VTDATAROOT to the /tmp folder to reduce the file path of mysql.sock file
+        # which musn't be more than 107 characters long.
+        export VTDATAROOT="/tmp/"
+        source build.env
+        make build
+
+        set -exo pipefail
+
+        vitess-tester --sharded --xunit --test-dir ./go/test/endtoend/vtgate/vitess_tester --vschema ./go/test/endtoend/vtgate/vitess_tester/vschema.json
+
+    - name: Print test output and Record test result in launchable if PR is not a draft
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true' && always()
+      run: |
+        if [[ "${{steps.skip-workflow.outputs.is_draft}}" ==  "false" ]]; then
+          # send recorded tests to launchable
+          launchable record tests --build "$GITHUB_RUN_ID" go-test . || true
+        fi
+
+        # print test output
+        cat report.xml
+
+    - name: Test Summary
+      if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true' && always()
+      uses: test-summary/action@v2
+      with:
+        paths: "report.xml"
+        show: "fail, skip"

go/test/endtoend/vtgate/vitess_tester/queries.test

@@ -0,0 +1,68 @@
+create table user
+(
+    id   bigint,
+    name varchar(255),
+    primary key (id)
+) Engine = InnoDB;
+
+create table music
+(
+    id      bigint,
+    user_id bigint,
+    primary key (id)
+) Engine = InnoDB;
+
+insert into music(id, user_id)
+values (1, 1),
+       (2, 5),
+       (3, 1),
+       (4, 2),
+       (5, 3),
+       (6, 4),
+       (7, 5);
+
+insert into user(id, name)
+values (1, 'toto'),
+       (2, 'tata'),
+       (3, 'titi'),
+       (4, 'tete'),
+       (5, 'foo');
+
+# TestDerivedTableWithOrderByLimit
+select music.id
+from music
+         join (select id, name from user order by id limit 2) as d on music.user_id = d.id;
+
+# TestDerivedAggregationOnRHS
+set sql_mode = '';
+select d.a
+from music
+         join (select id, count(*) as a from user) as d on music.user_id = d.id
+group by 1;
+
+# TestDerivedRemoveInnerOrderBy
+select count(*)
+from (select user.id as oui, music.id as non
+      from user
+               join music on user.id = music.user_id
+      order by user.name) as toto;
+
+# TestDerivedTableColumns
+SELECT t.id
+FROM (SELECT id FROM user) AS t(id)
+ORDER BY t.id DESC;
+
+# TestDerivedTableColumnAliasWithJoin
+SELECT user.id
+FROM user
+         join (SELECT id as uid FROM user) t on t.uid = user.id;
+SELECT user.id
+FROM user
+         left join (SELECT id as uid FROM user) t on t.uid = user.id;
+SELECT user.id
+FROM user
+         join (SELECT id FROM user) t(uid) on t.uid = user.id;
+SELECT user.id
+FROM user
+         left join (SELECT id FROM user) t(uid) on t.uid = user.id;
+

go/test/endtoend/vtgate/vitess_tester/vschema.json

@@ -0,0 +1,33 @@
+{
+  "routing_rules": null,
+  "shard_routing_rules": null,
+  "keyspace_routing_rules": null,
+  "keyspaces": {
+    "ks_derived": {
+      "sharded": true,
+      "vindexes": {
+        "user_index": {
+          "type": "hash"
+        }
+      },
+      "tables": {
+        "user": {
+          "column_vindexes": [
+            {
+              "column": "id",
+              "name": "user_index"
+            }
+          ]
+        },
+        "music": {
+          "column_vindexes": [
+            {
+              "column": "user_id",
+              "name": "user_index"
+            }
+          ]
+        }
+      }
+    }
+  }
+}

test/ci_workflow_gen.go

@@ -39,7 +39,6 @@ type mysqlVersions []mysqlVersion
 
 var (
 	defaultMySQLVersions = []mysqlVersion{defaultMySQLVersion}
-	allMySQLVersions     = []mysqlVersion{mysql57, mysql80}
 )
 
 var (
@@ -55,6 +54,8 @@ const (
 	// to be used.
 	clusterTestTemplate = "templates/cluster_endtoend_test%s.tpl"
 
+	clusterVitessTesterTemplate = "templates/cluster_vitess_tester.tpl"
+
 	clusterTestDockerTemplate = "templates/cluster_endtoend_test_docker.tpl"
 )
 
@@ -121,6 +122,10 @@ var (
 		"vttablet_prscomplex",
 	}
 
+	vitessTesterMap = map[string]string{
+		"vtgate": "./go/test/endtoend/vtgate/vitess_tester",
+	}
+
 	clusterDockerList           = []string{}
 	clustersRequiringXtraBackup = []string{
 		"xb_backup",
@@ -162,8 +167,14 @@ type clusterTest struct {
 	Cores16                            bool
 }
 
+type vitessTesterTest struct {
+	FileName string
+	Name     string
+	Path     string
+}
+
 // clusterMySQLVersions return list of mysql versions (one or more) that this cluster needs to test against
-func clusterMySQLVersions(clusterName string) mysqlVersions {
+func clusterMySQLVersions() mysqlVersions {
 	switch {
 	// Add any specific clusters, or groups of clusters, here,
 	// that require allMySQLVersions to be tested against.
@@ -197,6 +208,7 @@ func mergeBlankLines(buf *bytes.Buffer) string {
 
 func main() {
 	generateUnitTestWorkflows()
+	generateVitessTesterWorkflows(vitessTesterMap, clusterVitessTesterTemplate)
 	generateClusterWorkflows(clusterList, clusterTestTemplate)
 	generateClusterWorkflows(clusterDockerList, clusterTestDockerTemplate)
 }
@@ -211,10 +223,27 @@ func canonnizeList(list []string) []string {
 	return output
 }
 
+func generateVitessTesterWorkflows(mp map[string]string, tpl string) {
+	for test, testPath := range mp {
+		tt := &vitessTesterTest{
+			Name: fmt.Sprintf("Vitess Tester (%v)", test),
+			Path: testPath,
+		}
+
+		templateFileName := tpl
+		tt.FileName = fmt.Sprintf("vitess_tester_%s.yml", test)
+		workflowPath := fmt.Sprintf("%s/%s", workflowConfigDir, tt.FileName)
+		err := writeFileFromTemplate(templateFileName, workflowPath, tt)
+		if err != nil {
+			log.Print(err)
+		}
+	}
+}
+
 func generateClusterWorkflows(list []string, tpl string) {
 	clusters := canonnizeList(list)
 	for _, cluster := range clusters {
-		for _, mysqlVersion := range clusterMySQLVersions(cluster) {
+		for _, mysqlVersion := range clusterMySQLVersions() {
 			test := &clusterTest{
 				Name:  fmt.Sprintf("Cluster (%s)", cluster),
 				Shard: cluster,
@@ -257,7 +286,7 @@ func generateClusterWorkflows(list []string, tpl string) {
 				test.EnableBinlogTransactionCompression = true
 			}
 			mysqlVersionIndicator := ""
-			if mysqlVersion != defaultMySQLVersion && len(clusterMySQLVersions(cluster)) > 1 {
+			if mysqlVersion != defaultMySQLVersion && len(clusterMySQLVersions()) > 1 {
 				mysqlVersionIndicator = "_" + string(mysqlVersion)
 				test.Name = test.Name + " " + string(mysqlVersion)
 			}