Merge pull request #2 from macbre/index-digest-dsn

Add index-digest-dsn option

.github/workflows/ci.yml

@@ -15,13 +15,38 @@ jobs:
         - "1.4.0"
         - "latest"
 
+    services:
+      # https://hub.docker.com/_/mysql
+      database:
+        image: "mysql:8.0.22"
+        env:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+            MYSQL_DATABASE: index_digest
+        ports:
+            - "3310:3306"  # will be listening on 3310 host port
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
     steps:
       - uses: actions/checkout@v2
+
+      - name: Import test schema into the database
+        run: |
+          mysql --host=127.0.0.1 --port=3310 --user=root --database=index_digest < ./sql/0000_setup.sql
+
+          echo -e "[client]\nuser=digest\npassword=s3cr3t\n" > ~/.my.cnf
+          mysql --host=127.0.0.1 --port=3310 --user=digest --database=index_digest < ./sql/0001_redundant_indices.sql
+          mysql --host=127.0.0.1 --port=3310 --user=digest --database=index_digest  --execute="SHOW TABLES"
 
+      # docker run --network=host -t macbre/index-digest:latest mysql://index_digest:qwerty@debian/index_digest  | head -n 20
       - name: Run an action
         uses: ./
         with:
           index-digest-version: ${{ matrix.index-digest-version }}
+          index-digest-dsn: "mysql://digest:s3cr3t@127.0.0.1:3310/index_digest"
+          index-digest-report-file: "./report.yml"
+
+      - name: Check the version and the output file
+        run: |
+          docker run -t macbre/index-digest:${{ matrix.index-digest-version }} --version
+          cat ./report.yml
 
-      - name: Check the version
-        run: docker run -t macbre/index-digest:${{ matrix.index-digest-version }} --version

action.yml

@@ -10,6 +10,21 @@ inputs:
     description: "The version of index-digest to install"
     required: true
     default: "1.4.0"
+
+  index-digest-dsn:
+    description: "DSN pointing at the database to check"
+    require: true
+
+  index-digest-checks:
+    description: "Which index-digest checks to perform"
+    require: true
+    default: "redundant_indices,missing_primary_index,not_used_indices,queries_not_using_index,queries_using_filesort,queries_using_temporary,queries_using_full_table_scan"
+
+  index-digest-report-file:
+    description: "Where to save YAML report file"
+    required: true
+    default: "/tmp/index-digest.yml"
+
 runs:
   using: "composite"
   steps:
@@ -19,6 +34,9 @@ runs:
         echo "Using index-version v${{ inputs.index-digest-version }} ..."
         docker pull macbre/index-digest:${{ inputs.index-digest-version }}
 
-#     - shell: bash
-#       # run: docker run --network=host -t macbre/index-digest:latest mysql://index_digest:qwerty@debian/index_digest  | head -n 20
-#       run: docker run --network=host -t macbre/index-digest:${{ inputs.index-digest-version }} --version
+    - shell: bash
+      run: |
+        docker run --network=host -t macbre/index-digest:${{ inputs.index-digest-version }} \
+          --checks=${{ inputs.index-digest-checks }} \
+          --format=yaml \
+          ${{ inputs.index-digest-dsn }} | tee ${{ inputs.index-digest-report-file }}

sql/0000_setup.sql

@@ -0,0 +1,6 @@
+-- create a test user and grant access to our database
+-- "mysql_native_password" used to fix "Plugin caching_sha2_password could not be loaded" issue
+CREATE USER 'digest'@'%' IDENTIFIED WITH mysql_native_password BY 's3cr3t';
+
+GRANT ALL ON index_digest.* TO 'digest'@'%';
+

sql/0001_redundant_indices.sql

@@ -0,0 +1,7 @@
+CREATE TABLE `0001_redundant_indices` (
+	`item_id` int(9) NOT NULL AUTO_INCREMENT,
+	`foo` varbinary(16) NOT NULL DEFAULT '',
+	PRIMARY KEY (`item_id`),
+	UNIQUE KEY `idx_foo` (`foo`),
+	UNIQUE KEY `idx_foo_2` (`foo`)
+);