Testing your Implementation

We provide a number of automated tests and tools that you can use to test your implementation.

Automated tests

You can run the chidb automated tests by running this:

make check

Running tests selectively

Running through the entire test suite can be cumbersome if you’re trying to debug only a specific issue. You can run individual groups of tests like this:

  • Assignment 1:

    CK_RUN_CASE="Step 1a: Opening an existing chidb file" make check
    CK_RUN_CASE="Step 1b: Opening a new chidb file" make check
    CK_RUN_CASE="Step 2: Loading a B-Tree node from the file" make check
    CK_RUN_CASE="Step 3: Creating and writing a B-Tree node to disk" make check
    CK_RUN_CASE="Step 4: Manipulating B-Tree cells" make check
    CK_RUN_CASE="Step 5: Finding a value in a B-Tree" make check
    CK_RUN_CASE="Step 6: Insertion into a leaf without splitting" make check
    CK_RUN_CASE="Step 7: Insertion with splitting" make check
    CK_RUN_CASE="Step 8: Supporting index B-Trees" make check
    
  • Assignment 2:

    CK_RUN_SUITE="dbm-register" make check
    CK_RUN_SUITE="dbm-flow" make check
    CK_RUN_SUITE="dbm-cursor" make check
    CK_RUN_SUITE="dbm-record" make check
    CK_RUN_SUITE="dbm-sql-select" make check
    CK_RUN_SUITE="dbm-sql-insert" make check
    CK_RUN_SUITE="dbm-sql-create" make check
    CK_RUN_SUITE="dbm-index" make check
    

Sample “string” B-Tree files

We provide a number of files that can be used to debug your B-Tree code. The “string” B-Tree files are chidb files with a single B-Tree, always rooted in page 1, where the contents of each leaf cell is just a nul-terminated string, instead of a database record. Everything else follows the chidb file format specification (file header, page headers, etc.). Although they are not strictly well-formed chidb files, they are easier to read with a binary editor. Note that, regardless of the string length, each string occupies 128 bytes in the cell.

tests/files/databases/strings-1page.sdb

This file has a single page which contains a single B-Tree.

Leaf node (page 1)
    1 ->       foo1
    2 ->       foo2
   10 ->      foo10
   35 ->      foo35
   37 ->      foo37
   42 ->      foo42

tests/files/databases/strings-1btree.sdb

This file contains a single B-Tree with height 2. The root node is located in page 1, and its child nodes are located in pages 2, 3, 4, and 5.

Internal node (page 1)
Printing Keys <= 7
Leaf node (page 4)
    1 ->       foo1
    2 ->       foo2
    3 ->       foo3
    7 ->       foo7
Printing Keys <= 35
Leaf node (page 3)
   10 ->      foo10
   15 ->      foo15
   20 ->      foo20
   35 ->      foo35
Printing Keys <= 1000
Leaf node (page 5)
   37 ->      foo37
   42 ->      foo42
  127 ->     foo127
 1000 ->    foo1000
Printing Keys > 1000
Leaf node (page 2)
 2000 ->    foo2000
 3000 ->    foo3000
 4000 ->    foo4000
 5000 ->    foo5000

Sample chidb files

We also provide several well-formed chidb files, which can also be used to test your B-Tree code, but are better suited for Assignments 2 and 3. Unlike the “string” databases, each leaf cell contains a database record, and the database includes a schema table in page 1. All these files can also be opened in SQLite.

tests/files/databases/1table-1page.cdb

This file contains a single table occupying a single page (page 2).

Schema table:
Leaf node (page 1)
<     1 >| table | courses | courses | 2 | CREATE TABLE courses(code INTEGER PRIMARY KEY, name TEXT, prof BYTE, dept INTEGER) |

Table:
Leaf node (page 2)
< 21000 >|| Programming Languages | 75 | 89 |
< 23500 >|| Databases || 42 |
< 27500 >|| Operating Systems || 89 |

tests/files/databases/1table-1index-1pageeach.cdb

This file contains a single table and an index on that table. The table occupies a single page (page 2) and the index occupies a single page (page 3).

Schema table:
Leaf node (page 1)
<     1 >| table | numbers | numbers | 2 | CREATE TABLE numbers(code INTEGER PRIMARY KEY, textcode TEXT, altcode INTEGER) |
<     2 >| index | idxNumbers | numbers | 3 | CREATE INDEX idxNumbers ON numbers(altcode) |

Table:
Leaf node (page 2)
<   100 >|| foo100 | 20100 |
<   200 >|| foo200 | 20200 |
<   300 >|| foo300 | 20300 |

Index:
Leaf node (page 3)
     20100 ->        100
     20200 ->        200
     20300 ->        300

tests/files/databases/1table-largebtree.cdb

This is a file with the same table and index as the previous file, but where the table B-Tree has height 3. The total size of the file is 202 pages.

The DBM File Format

To test your implementation of the Database Machine (DBM), chidb provides a format for specifying DBM programs that can be easily loaded and run before you have a code generator that can translate SQL to DBM operations. Many sample programs are included in tests/files/dbm-programs, and they are run automatically as part of the tests when running make check.

The DBM File (DBMF) format is divided into four sections, separated by %%:

Database file

%%

DBM instructions or SQL statement

%%

Query results

%%

Expected register values

The database file specification can be one of the following:

  • NO DBFILE: Indicates that no database file is necessary to run this DBM program.
  • CREATE file: Creates a new database called file in tests/files/generated/, and run the DBM program on it.
  • USE file: Take database file from tests/files/databases/, create a copy in tests/files/generated/, and run the DBM program on it.

The next section can either contain DBM instructions or a SQL query. If it contains DBM instructions, this will be a list of DBM instructions in the following format:

opcode P1 P2 P3 P4

Each value can be separated by any amount of space characters. When an operation does not expect a value for one of its parameters, an underscore character is used. For example:

Integer 42  5   _   _

When present, P4 must always be written with double quotes. For example:

String 13  5   _   "Hello, world!"

If it contains a SQL statement, it will be a single SQL statement in a single line. This statement will be compiled into a DBM program when the DBMF file is loaded, which requires a working code generator.

The query results contain one line per row returned by the program. Each column can be separated by any amount of space characters. Strings must be written in double quotes, and a null value must be written as NULL. For example:

21000  "Programming Languages"   75    89
23500  "Databases"               NULL  42
27500  "Operating Systems"       NULL  89

If the query results section is empty, no checks will be performed on the rows returned by the program.

The expected register values contains specifications of registers in the following format:

R_N type [value]

Where N is the register number, type is unspecified, null, integer, string, or binary. Optionally, a value can be provided (note: values cannot be provided for binary registers). If a value is not provided, the tests will only check whether the type of the register is correct.

For example:

R_0 integer 2
R_1 integer 1
R_2 null
R_3 string "Hard Drive"
R_4 integer 240
R_5 binary

Note that not all registers have to be specified. In other words, if the program uses a register, and it is not included in the expected register values, that will not result in an error.

Note that DBMF files with a SQL statement instead of a DBM program will usually omit the registers section of the file (since the registers will depend on the generated code).

This is an example of a complete DBMF file, corresponding to running SELECT * FROM courses on file 1table-1page.cdb described above:

USE 1table-1page.cdb

%%

Integer      2  0  _  _
OpenRead     0  0  4  _
Rewind       0  9  _  _
Key          0  1  _  _
Column       0  1  2  _
Column       0  2  3  _
Column       0  3  4  _
ResultRow    1  4  _  _
Next         0  3  _  _
Close        0  _  _  _
Halt         _  _  _  _

%%

21000  "Programming Languages"   75    89
23500  "Databases"               NULL  42
27500  "Operating Systems"       NULL  89

%%

R_0 integer 2
R_1 integer

And this is an example of an equivalent DBMF file where a SQL statement is specified instead of a DBM program:

USE 1table-1page.cdb

%%

SELECT * FROM courses;

%%

21000  "Programming Languages"   75    89
23500  "Databases"               NULL  42
27500  "Operating Systems"       NULL  89