Home Original page

Release Checklist for SQLite 3.49.0

  • Test procedure review.

    1. Review "test/testrunner.tcl" and "test/testrunner_data.tcl" for completeness and accuracy.
    2. Review "multitest.tcl" and "alignment*.rc" scripts in TH3 for completeness.
    3. Review this checklist for completeness and accuracy.
    4. Review dev-ops procedures and make any needed updates and corrections.

  • Source code change review. fossil diff --from release --to trunk

    1. No stray changes.
    2. All significant changes are mentioned in the "changes" log of the documentation.
    3. New code complies with style guidelines.
    4. New code complies with design rules.
    5. Comments have been updated to reflect code changes.
    6. Verify that the azProhibitedFunctions list in the safeModeAuth() function of the CLI is complete and up-to-date.
    7. Variables and functions have been renamed to reflect changes in their use.
    8. Check all calls to sqlite3OsRead() and sqlite3OsWrite() to ensure that offset computations are 64-bit clean.
    9. Check all calls to memory allocation routines to ensure that size computations are 64-bit clean. Suggested regular expression for search: /(Re|M)alloc[FORZa-z]*(/
    10. Verify that source code contains no tabs characters.
    11. Verify that the list of APIs exposed via the extension header is up-to-date (sqlite3ext.h).
    12. Significant compile-time options are recognized by the sqlite3_compileoption_used() interface.
    13. Compare sqlite3.c and sqlite3.h against the previous release.

  • Documentation review:

    1. Latest release on the "index.html" page.
    2. Release announcement in "changes.in".
    3. Release accouncement in "news.html".
    4. No unresolved hyperlinks in the documentation build.
    5. The compile-time options are all up-to-date (compile.html).
    6. Database footprint is up-to-date (features.html).
    7. Test metrics are up-to-date (testing.html).
    8. Check new/changed documentation for spelling and gramatical mistakes.

  • Compiler warning checks.

    1. Linux GCC -Wall -Wextra (the "tool/warnings.sh" script)
    2. Mac OS X GCC -Wall -Wextra (the "tool/warnings.sh" script)
    3. CFLAGS='-O0' ./configure --enable-debug --enable-all && scan-build make sqlite3

  • OMIT, ENABLE, and DISABLE options:

    1. Recent compile-time options have been added to the omittest.tcl and omittest-msvc.tcl scripts and checked in.
    2. tclsh tool/omittest.tcl ← on Linux
    3. tclsh tool/omittest-msvc.tcl ← on Windows

  • Tests for platform Linux x86_64:

    1. ./configure && make verify-source releasetest
    2. sh tool/symbols.sh - no incorrect exports or dependencies
    3. ./configure --enable-debug --enable-all && make parse.c && CC=clang CFLAGS='-fsanitize=address,undefined' make -e test
    4. Test the reuse-schema branch with ./configure --enable-all && make "OPTS=-DSQLITE_ENABLE_SHARED_SCHEMA" sdevtest
    5. CC=clang CFLAGS='-fsanitize=thread' ./configure && make threadtest5 && ./threadtest5
    6. Run auxiliary test script in the /usr subdirectory of the TH3 repository
    7. Verify that the SQLITE_HAVE_SQLITE3R is needed when building the CLI using sqlite3r.c: ./configure --enable-all && make sqlite3r.c shell.c && gcc -DSQLITE_ENABLE_DBPAGE_VTAB -DSQLITE_HAVE_SQLITE3R sqlite3r.c shell.c -ldl -lpthread && ./a.out '' .recover
    8. From a read-only source tree: $SRC/configure && make devtest
    9. In sibling th3 checkout: make releasetest
    10. In sibling th3 checkout: tclsh multitest.tcl --scenario coverage
    11. In sibling th3 checkout: tclsh multitest.tcl --scenario failures - all failures detected

  • Tests for platform Linux ARM (RaspberryPI)

    1. ./configure && make verify-source devtest
    2. In sibling TH3 checkout: make devtest

  • Tests for platform MacOS x64:

    1. ./configure && make verify-source releasetest
    2. In sibling TH3 checkout: make devtest
    3. In sibling TH3 checkout: tclsh multitest.tcl --scenario failures - all failures detected

  • Tests for platform MacOS ARM:

    1. ./configure && make verify-source releasetest. Optionally add --enable-test-status to configure
    2. In sibling TH3 checkout: make releasetest

  • Tests for platform MacOS (PPC):

    1. .selftest checks (see below)
    2. Build sqlite3_rsync. Use it to sync a Fossil repo from a little-endian machine then verify that the synced repo is correct. This demonstrates that databases are x-platform between big- and little-ending systems.
    3. Recompile and test Fossil.

  • Tests for platform Windows (32-bit):

    1. Review the "32-bit Builds" section of doc/compile-for-windows.md for accuracy and completeness. Ensure that your build environment is set up correctly. You probably want:
      • set TCLDIR=c:\tcl32
      • set PATH=c:\tcl32\bin;%PATH%
    2. In sibling TH3 checkout: nmake devtest
    3. In sibling TH3 checkout: tclsh multitest.tcl --msvc --scenario failures - verify failures detected
    4. nmake /f Makefile.msc verify-source releasetest
    5. Verify that EXEs and DLLs generated using MSVC contain the correct version number, product name, description, and copyright as resources.

  • Tests for platform Windows (64-bit):

    1. Review the first part of doc/compile-for-windows.md for correctness. Ensure that the local build environment is correct, especially the TCLDIR variable.
    2. In sibling TH3 checkout: nmake releasetest
    3. In sibling TH3 checkout: tclsh multitest.tcl --msvc --scenario failures - verify failures detected
    4. nmake /f Makefile.msc verify-source releasetest
    5. Verify that EXEs and DLLs generated using MSVC contain the correct version number, product name, description, and copyright as resources.
    6. After updating Fossil to use the latest SQLite, verify that it compiles without warnings and that it works

  • Tests for platform OpenBSD (x86):

    1. ./configure && make devtest
    2. In sibling TH3 directory: make devtest

  • WASM

    1. Build and install Fiddle according to website maintenance instructions at https://sqlite.org/devops/doc/trunk/build/website-build.md. Run simple tests.
    2. (On Linux) ./configure --enable-all && cd ext/wasm && make
    3. Run "althttpd --enable-sab --popup --max-age 1" then visit the HOST:PORT/index.html in a web-browser.
    4. Click on the test links - confirm correct results.

  • Building The TCL Extension. Detailed procedures document at https://sqlite.org/src/doc/trunk/doc/tcl-extension-testing.md

    1. Tested on Linux
    2. Tested on Mac
    3. Tested on Windows

  • Verify the "install" make target using DESTDIR:
    • Create a new temporary directory. Call it $tempdir.
    • fossil clean -x && ./configure && make install DESTDIR=$tempdir
    • Verify correct installation using tree $tempdir

  • On an F2FS filesystem with the F2FS_FEATURE_ATOMIC_WRITE feature, test with: $TOP/configure && make test OPTS="-DSQLITE_ENABLE_BATCH_ATOMIC_WRITE -DSQLITE_DEBUG -DSQLITE_NO_SYNC". Check that test script "atomic2.test" really did run, and did not report "No f2fs atomic-batch-write support. Skipping tests...".

  • Trunk changes merged and verified on active branches. See https://sqlite.org/devops/doc/trunk/build/release-actions-drh.md for detailed instructions.

    1. begin-concurrent (from trunk)
    2. wal2 (from trunk)
    3. bedrock (from wal2)
    4. reuse-schema (from trunk)
    5. see (in the see-base repository)
    6. client-see (in the see-base repository)
    7. reuse-schema-see (in the see-base repository)

  • Dbsqlfuzz tests

    1. Develop a new CORPUS database by running dbsqlfuzz for 10 billion iterations
    2. Check-in CORPUS as an unversioned file in the dbsqlfuzz repository
    3. Linux: FUZZDB=$CORPUS make run-fuzzcheck
    4. Mac: FUZZDB=$CORPUS make run-fuzzcheck
    5. Windows: fuzzcheck $CORPUS -spinner

  • Sqllogictest:

    1. Checked in latest SQLite amalgamation.
    2. No SQLite compiler warnings.
    3. tclsh run-all.tcl

  • Fossil updated to use the latest SQLite.

    1. No SQLite compiler warnings.
    2. Used on active websites with no issues.
    3. fossil all test-integrity -d
    4. fossil all sync --all
    5. fossil all repack
    6. Do the above on Linux
    7. Do the above on Mac
    8. Do the above on RaspberryPi
    9. Do the above on Windows

  • Wapp updated to use the latest SQLite

    1. Used for this checklist - verify on the CGI-environment page
    2. https://sqlite.org/src/ext/logview
    3. https://sqlite.org/src/ext/officeipaddr

  • CEROD tests in the "test/" subdirectory.

  • SEE tests using TH3. From the TH3 source directory with the sibling ../see for the SEE sources.

    1. Linux: make clean see-test
    2. Mac: make clean see-test
    3. Windows: nmake clean see-test

  • ZIPVFS tests. (See also https://sqlite.org/devops/doc/trunk/build/zipvfs.md)

    1. Verify that the configure script version number agrees with the SQLite version number
    2. testfixture test/testrunner.tcl --zipvfs <ZIPVFS-source-directory> zipvfs
    3. Linux: tclsh multitest.tcl --scenario zipvfs --extra --valgrind --omit 'quick[23]'
    4. Mac: tclsh multitest.tcl --scenario zipvfs
    5. Windows: tclsh multitest.tcl --scenario zipvfs

  • NDS-Devkit testing - see https://sqlite.org/devops/doc/trunk/build/release-actions-drh.md#sec9.0 for additional guidance.

    1. Merge all trunk enhancements into the reuse-schema branch and use that branch to update the devkit.
    2. Test using: tclsh th3make debug.rc nds_devkit.rc -v ← Note that the -v option is needed in order to see the NDS DevKit version number in the output.
    3. Verify the "NDS DevKit" version number shown at the end of the test

  • Amalgamation autoconf tarball.

    1. Builds (using "make amalgamation-tarball" and/or "make snapshot-tarball").
    2. Works on Linux.
    3. Works on Mac OS X.
    4. Works on Windows MSVC

  • Performance tests using speedtest1 --testcase mix1 speedtest.db compared against prior releases. See the header comment on test/speedtest1.c for guidance on how to compile the latest speedtest1.c against historical amalgamations.

    1. Linux
    2. Mac
    3. Windows

  • Run make wordcount and do tests on current and prior versions:

    1. rm -f wc.db && ./wordcount wc.db $BIGTEXT --all
    2. rm -f wc.db && ./wordcount wc.db $BIGTEXT --all --cachesize 5 --nosync

  • Compare performance to the previous release using kvtest.

    1. Linux
    2. Mac
    3. Windows

  • Verify database file format compatibility:
    • Build the CLI ("sqlite3" or "sqlite3.exe")
    • Have ready a check-out of the https://sqlite.org/test-dbs Fossil repository containing the test databases in sibling directory "../dbs".
    • Start the CLI.
    • .cd ../dbs
    • .read selftest.txt
    Verify that all tests pass.

    1. iBook PPC
    2. Linux x64
    3. Linux ARM
    4. Mac x64
    5. Mac ARM
    6. Windows 32-bit
    7. Windows 64-bit

  • Verify that the amalgamation builds are byte-for-byte identical on all workstation platforms.

    1. Linux (x64)
    2. Linux (ARM)
    3. Mac (x64)
    4. Mac (PPC)
    5. Mac (ARM)
    6. Windows using NMAKE.

  • Verify that databases (including FTS3 and RTREE databases), rollback journals, and WAL files created by the release candidate are readable and writeable by historical versions of SQLite (as long as no unsupported features are used) and vice versa.

  • Build and verify correct operation of sqlite3_analyzer on:

    1. Linux
    2. Mac
    3. Windows

  • Build and verify sqldiff

    1. Linux
    2. Mac
    3. Windows

  • Build and verify sqlite3_rsync

    1. Linux
    2. Mac
    3. Windows

  • Build the "atrc" test program and run "./atrc $DB | ./sqlite3 $DB" against multiple databases, visually verify the result

  • Run the rbu/run_rbu_tests.tcl script in the test-dbs project on Linux.

  • Verify that the "sqlite3-all.c" build target works and that the resulting "sqlite3-all.c" file and its include files ("sqlite3-?.c") compile and run the same as the single-file amalgamation.

  • Website built procedures

    1. Compile-time options for build products have been updated as necessary
    2. All build products work on their target platforms