Merge branch 'main' into fix/typo-readme-test-python-version

Author: dongwook-chan

.github/workflows/coverage.yml

@@ -0,0 +1,47 @@
+name: Python Coverage
+on: 
+  push:
+  pull_request:
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Run database server in docker
+        run: |
+          docker compose create
+          docker compose start
+          echo "wait mysql server"
+
+          while :
+          do
+            if mysql -h 127.0.0.1 --user=root --execute "SELECT version();" 2>&1 >/dev/null && mysql -h 127.0.0.1 --port=3307 --user=root --execute "SELECT version();" 2>&1 >/dev/null; then
+              break
+            fi
+            sleep 1
+          done
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install pytest coverage smokeshow
+
+      - name: Run coverage
+        run: |
+          coverage run -m pytest -k "not test_no_trailing_rotate_event and not test_end_log_pos and not test_query_event_latin1"
+          coverage html
+
+      - run: smokeshow upload htmlcov
+        env:
+          SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 60

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x' # This will install the latest version of Python 3
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff black
+
+      - name: Run lint script
+        run: bash scripts/lint.sh

.github/workflows/pytest.yml

@@ -1,6 +1,10 @@
 name: PyTest
-on: [push, pull_request]
-
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+env:
+  PYTEST_SKIP_OPTION: "not test_no_trailing_rotate_event and not test_end_log_pos"
 jobs:
   test:
     strategy:
@@ -13,14 +17,14 @@ jobs:
           - {name: 'Pypy 3.9', python: 'pypy-3.9'}
     name: ${{ matrix.name }}
     runs-on: ubuntu-latest
-    timeout-minutes: 2
+    timeout-minutes: 3
 
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
@@ -29,22 +33,34 @@ jobs:
           docker compose create
           docker compose start
           echo "wait mysql server"
-        
+
           while :
           do
-            if mysql -h 127.0.0.1 --user=root --execute "SELECT version();" 2>&1 >/dev/null && mysql -h 127.0.0.1 --port=3307  --user=root --execute "SELECT version();" 2>&1 >/dev/null; then
+            if mysql -h 127.0.0.1 --user=root --execute "SELECT version();" 2>&1 >/dev/null && mysql -h 127.0.0.1 --port=3307 --user=root --execute "SELECT version();" 2>&1 >/dev/null; then
               break
             fi
             sleep 1
           done
-          
+
           echo "run pytest"
 
       - name: Install dependencies
         run: |
           pip install .
           pip install pytest
 
-      - name: Run test suite
-        run: |
-          pytest -k "not test_no_trailing_rotate_event and not test_end_log_pos"
+      - name: Run tests for mysql-5
+        working-directory: pymysqlreplication/tests
+        run: pytest -k "$PYTEST_SKIP_OPTION" --db=mysql-5
+
+      - name: Run tests for mysql-5-ctl
+        working-directory: pymysqlreplication/tests
+        run: pytest -k "$PYTEST_SKIP_OPTION" --db=mysql-5-ctl
+
+      - name: Run tests for mysql-8
+        working-directory: pymysqlreplication/tests
+        run: pytest -k "$PYTEST_SKIP_OPTION" --db=mysql-8
+
+      - name: Run tests for mariadb-10
+        working-directory: pymysqlreplication/tests
+        run: pytest -k "$PYTEST_SKIP_OPTION" -m mariadb --db=mariadb-10

.mariadb/my.cnf

@@ -20,4 +20,4 @@ loose_file_key_management_filename = /opt/key_file/no_encryption_key.key
 # file_key_management_encryption_algorithm=aes_ctr
 
 # Set encrypt_binlog
-encrypt_binlog=ON
+encrypt_binlog=ON

.mariadb/no_encryption_key.key

@@ -1 +1 @@
-1;dda0ccb18a28b0b4c2448b5f0217a134
+1;dda0ccb18a28b0b4c2448b5f0217a134

.mysql/dev.mysql.com.gpg.key

@@ -435,4 +435,3 @@ Pw1yjWJT1IhUBBgRAgAMBQJOdz3tBQkT+wG4ABIHZUdQRwABAQkQjHGNO1By4fUU
 mwCbBYr2+bBEn/L2BOcnw9Z/QFWuhRMAoKVgCFm5fadQ3Afi+UQlAcOphrnJ
 =tUml
 -----END PGP PUBLIC KEY BLOCK-----
-

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.286
+    hooks:
+    -   id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

CHANGELOG

@@ -84,7 +84,7 @@
 * PyMYSQL 0.7
 * Add more contributors
 
-0.10 30/11/2016 
+0.10 30/11/2016
 * row-events: TIME is now encoded as python.timedelta
 * Allow users to define ctl_connection_settings and the option to fail when table information is unavailable (#176)
 * Decode gtid from network packet
@@ -128,7 +128,7 @@
 
 0.19 29/04/2019
 * Fix Insert NULL in a boolean column returns no rows #288
-* Added empty string support for enum 
+* Added empty string support for enum
 * Fix column order
 * Fix float problem about time fieldtype
 
@@ -168,7 +168,7 @@
 * Add support for MariaDB GTID
 
 0.29 08/04/2022
-* Skip db name parsing if mts_accessed_dbs == 254 
+* Skip db name parsing if mts_accessed_dbs == 254
 
 0.30 28/04/2022
 * Fix decoding large json arrays
@@ -195,4 +195,39 @@
 * Fix release error
 
 0.43.0 23/07/2023
-* Bump PyMySQL to 1.1.0 to solve : LookupError: unknown encoding: utf8mb3
+* Bump PyMySQL to 1.1.0 to solve : LookupError: unknown encoding: utf8mb3
+
+0.44.0 12/09/2023
+* Add MariadbAnnotateRowsEvent
+* Add RandEvent
+* Add MariadbStartEncryptionEvent
+* Add RowsQueryLogEvent
+* Add MariadbBinLogCheckPointEvent
+* Add PreviousGtidsEvent
+* Add UserVarEvent
+* Fix Bug increase history list length and snapshot : Mysql 8.0 version connection was being created along with the opening of a transaction. This led to a problem with looking at the snapshot before creating the table
+* Fix Avoid UnicodeDecodeError for non-utf8 QueryEvents
+* Enhance Data Integrity with Binlog Event Checksum Verification
+* Fix Bug table map event read null_bitmask packet
+* Fix Timestamp conversion to return UTC instead of local timezone
+* Optimize Handler_read_rnd by removing ORDER BY clause
+
+0.45.0 02/10/2023
+* Fix Json object, Array parse Error
+
+1.0.0 02/10/2023
+* remove column schema
+* Mysql 8.0.14 version support Table map Event optional metaData extraction
+* Sync Column from optional metaData
+* Fix parsing of incorrect bytes in 'extradata' for 'rows event'
+* Fix remove duplicate Affected columns output
+* Enhance Code Quality with Ruff, Black, and Pre-commit
+* Enhance Testing with MySQL8 & Update GitHub Actions
+* Add Logging when fake rotate event occured
+* update logo
+
+1.0.1 05/10/2023
+* add util module
+
+1.0.2 05/10/2023
+* Delete charset_list.csv and add directly in CHARSET.py

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to python-mysql-replication
+
+Firstly, thank you for considering to contribute to `python-mysql-replication`. We appreciate your effort, and to ensure that your contributions align with the project's coding standards, we employ the use of `pre-commit` hooks. This guide will walk you through setting them up.
+
+## Setting up pre-commit
+
+1. **Install pre-commit**
+
+   Before you can use `pre-commit`, you need to install it. You can do so using `pip`:
+
+   ```bash
+   pip install pre-commit
+   ```
+
+2. **Install the pre-commit hooks**
+
+   Navigate to the root directory of your cloned `python-mysql-replication` repository and run:
+
+   ```bash
+   pre-commit install
+   ```
+
+   This will install the `pre-commit` hooks to your local repository.
+
+3. **Make sure to stage your changes**
+
+   `pre-commit` will only check the files that are staged in git. So make sure to `git add` any new changes you made before running `pre-commit`.
+
+4. **Run pre-commit manually (Optional)**
+
+   Before committing, you can manually run:
+
+   ```bash
+   pre-commit run --all-files
+   ```
+
+   This will run the hooks on all the files. If there's any issue, the hooks will let you know.
+
+## If you encounter issues
+
+If you run into any problems with the hooks, you can always skip them using:
+
+```bash
+git commit -m "Your commit message" --no-verify
+```
+
+However, please note that skipping hooks might lead to CI failures if we use these checks in our CI pipeline. It's always recommended to adhere to the checks to ensure a smooth contribution process.
+
+---
+
+That's it! With these steps, you should be well on your way to contributing to `python-mysql-replication`. We look forward to your contributions!