/home/mrjunejune/zenbu: mrjunejune/test/snapshots/README.md annotate

annotate mrjunejune/test/snapshots/README.md @ 71:75de5903355c

Giagantic changes that update Dowa library to be more align with stb style array and hashmap. Updated Seobeo to be caching on server side instead of file level caching. Deleted bunch of things I don't really use.

author	June Park <parkjune1995@gmail.com>
date	Sun, 28 Dec 2025 20:34:22 -0800
parents	6626ec933933
children

rev	line source
67 6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	1 # Test Snapshots
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	2
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	3 This directory contains expected HTTP response snapshots for integration tests.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	4
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	5 ## How It Works
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	6
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	7 Each test case generates a snapshot file based on its URL path:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	8
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	9 - `/` → `root.snapshot`
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	10 - `/index.html` → `index.html.snapshot`
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	11 - `/api/users` → `api_users.snapshot`
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	12 - `/path/to/resource` → `path_to_resource.snapshot`
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	13
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	14 ## Workflow
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	15
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	16 ### First time (no snapshots exist):
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	17
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	18 1. Create snapshots:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	19 ```bash
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	20 bazel run //mrjunejune:create_snapshots
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	21 ```
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	22
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	23 This will:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	24 - Start the test server
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	25 - Make HTTP requests to all test paths
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	26 - Save responses to `mrjunejune/test/snapshots/`
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	27
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	28 2. Verify tests pass:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	29 ```bash
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	30 bazel test //mrjunejune:integration_test
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	31 ```
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	32
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	33 All tests should now pass since snapshots exist.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	34
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	35 ### Updating Snapshots
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	36
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	37 When you change the server response format:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	38
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	39 1. Regenerate snapshots:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	40 ```bash
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	41 bazel run //mrjunejune:create_snapshots
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	42 ```
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	43
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	44 2. Verify tests still pass:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	45 ```bash
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	46 bazel test //mrjunejune:integration_test
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	47 ```
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	48
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	49 3. Commit the updated snapshot files
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	50
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	51 ## Two Separate Commands
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	52
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	53 - `bazel run //mrjunejune:create_snapshots` - Creates/updates snapshot files (uses seobeo snapshot creator library)
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	54 - `bazel test //mrjunejune:integration_test` - Verifies responses match snapshots
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	55
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	56 This separation makes it clear when you're creating new snapshots vs. verifying against existing ones.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	57
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	58 ## Implementation Details
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	59
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	60 The snapshot creation is implemented in the seobeo library:
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	61 - `seobeo/snapshot_creator.h` - Snapshot creation API
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	62 - `seobeo/snapshot_creator.c` - Implementation
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	63 - `mrjunejune/test/create_snapshots.c` - Binary that uses the library
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	64
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	65 This makes snapshot creation reusable across different projects.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	66
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	67 ## Special Cases
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	68
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	69 ### 200 OK Responses
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	70 Only 200 OK responses are verified against snapshots. This ensures successful responses remain consistent.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	71
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	72 ### Redirects (3xx status codes)
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	73 Redirect responses skip content comparison - only the status code is verified.
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	74
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	75 ### Error Responses (4xx, 5xx)
6626ec933933 [Seobeo] Separated out Client Server logic. Created test tools. June Park <parkjune1995@gmail.com> parents: diff changeset	76 Error status codes are verified but content comparison is skipped to allow for response format flexibility.

Mercurial

annotate mrjunejune/test/snapshots/README.md @ 71:75de5903355c