Grad.Codebook.Testing 2.0.3

Grad.Codebook.Testing

Testing utilities for Grad Codebook. This package allows projects that depend on Codebook to test functionality that requires database access.

Purpose

The Grad.Codebook package exposes data through database views that query from the EDW (Enterprise Data Warehouse). For testing purposes, projects need a way to set up a test database without depending on the EDW. This package provides that capability by creating tables instead of views and populating them with representative test data.

Usage

using Grad.Codebook.Testing;

// Create an instance with your test database connection string
var testDb = new CodebookTestDatabase(connectionString);

// Set up the database (creates tables and inserts test data)
testDb.Setup();

// Or use async version
await testDb.SetupAsync();

Test Data Constants

Instead of using magic strings in your tests, use the TestData class to access test data objects with all their properties:

using Grad.Codebook.Testing;

// Access test data as full objects with properties
var csProgram = TestData.GradPrograms.ComputerScienceMS;
Assert.Equal("10KS0112MS", csProgram.ProgramCode);
Assert.Equal("Computer Science", csProgram.MajorTitle);

// Use department codes
var csDepartment = TestData.Departments.ComputerScience;
Assert.Equal("434", csDepartment.DepartmentCode);
Assert.Equal("Department of Computer Science", csDepartment.FullName);

// Access all types of test data
var engineering = TestData.Colleges.Engineering;
var phdDegree = TestData.Degrees.PhD;
var mathMinor = TestData.Minors.Mathematics;
var csSubject = TestData.Subjects.ComputerScience;

Available test data categories:

• TestData.Colleges - Test colleges
• TestData.Departments - Test departments
• TestData.Degrees - Test degrees
• TestData.GradPrograms - Test graduate programs
• TestData.Minors - Test minors
• TestData.Majors - Test majors
• TestData.Subcolleges - Test subcolleges
• TestData.Subjects - Test subjects
• TestData.Concentrations - Test concentrations
• TestData.Curriculums - Test curriculums

What it Does

The CodebookTestDatabase class:

1. Creates the Codebook database if it doesn't exist
2. Drops existing tables if they exist (to ensure a clean state)
3. Creates tables that match the structure of the Codebook views:
   • colleges
   • departments
   • concentrations
   • curriculums
   • degrees
   • subcolleges
   • subjects
   • grad_programs
   • minors
   • majors
   • joint_programs
   • major_concentrations
   • program_concentrations
   • department_names
   • program_names
4. Inserts test data with representative examples of each entity type

Test Data

The package includes sample data for:

• 3 colleges (Engineering, Liberal Arts & Sciences, Graduate College)
• 3 departments (Computer Science, Mathematics, ECE)
• 4 graduate programs (CS MS, CS PhD, Math MS, Math PhD)
• 2 minors (CS, Math)
• 2 majors (CS, Math)
• 2 concentrations (AI, Database Systems)
• And corresponding relationships between these entities

Notes

While it's not ideal for dependent projects to use the database directly, this approach is necessary for scenarios involving complex joins that aren't feasible with API calls.