|
| 1 | +name: cycle116_postgres_execute |
| 2 | +version: "1.0.0" |
| 3 | +language: zig |
| 4 | +module: postgres_execute |
| 5 | + |
| 6 | +description: | |
| 7 | + ACTUAL EXECUTION of PostgreSQL extension compilation and deployment. |
| 8 | + This specification implements the real build, install, test, and verification |
| 9 | + of the pg_trinity extension using PGXS against PostgreSQL 16. |
| 10 | + |
| 11 | +types: |
| 12 | + BuildEnvironment: |
| 13 | + fields: |
| 14 | + pg_config: String # Path to pg_config |
| 15 | + postgres_version: String # Target PostgreSQL version |
| 16 | + pgxs_dir: String # PGXS directory location |
| 17 | + extension_dir: String # Extension build directory |
| 18 | + install_dir: String # Installation directory |
| 19 | + build_success: Bool # Build status |
| 20 | + install_success: Bool # Installation status |
| 21 | + |
| 22 | + ExtensionFile: |
| 23 | + fields: |
| 24 | + name: String # File name |
| 25 | + type: String # control, sql, c |
| 26 | + path: String # Full path |
| 27 | + exists: Bool # File exists check |
| 28 | + size: Int # File size in bytes |
| 29 | + checksum: String # SHA256 checksum |
| 30 | + |
| 31 | + TestResult: |
| 32 | + fields: |
| 33 | + test_name: String # Test name |
| 34 | + sql_query: String # SQL query executed |
| 35 | + expected: String # Expected result |
| 36 | + actual: String # Actual result |
| 37 | + passed: Bool # Test pass/fail |
| 38 | + execution_time: Float # Execution time in ms |
| 39 | + error_message: String # Error if any |
| 40 | + |
| 41 | + VerificationStatus: |
| 42 | + fields: |
| 43 | + extension_loaded: Bool # Extension in pg_extension |
| 44 | + functions_exist: Bool # Functions in pg_proc |
| 45 | + tables_exist: Bool # Tables created |
| 46 | + indexes_exist: Bool # Indexes created |
| 47 | + test_results: List<TestResult> |
| 48 | + overall_status: String # SUCCESS, FAILED, PARTIAL |
| 49 | + |
| 50 | +behaviors: |
| 51 | + - name: verify_postgres_installation |
| 52 | + given: System with PostgreSQL 16 installed |
| 53 | + when: Checking pg_config availability and version |
| 54 | + then: PostgreSQL 16 is confirmed with pg_config accessible |
| 55 | + notes: | |
| 56 | + which pg_config |
| 57 | + pg_config --version |
| 58 | + pg_config --configure |
| 59 | + |
| 60 | + - name: detect_pgxs_location |
| 61 | + given: PostgreSQL installation with PGXS support |
| 62 | + when: Querying pg_config for PGXS directory |
| 63 | + then: PGXS directory path is resolved and validated |
| 64 | + notes: | |
| 65 | + pg_config --pgxs |
| 66 | + Verify /usr/share/postgresql/extension/ or similar |
| 67 | + |
| 68 | + - name: create_extension_directory |
| 69 | + given: Project root with trinity/postgres/ directory |
| 70 | + when: Creating extension build directory structure |
| 71 | + then: Directory exists with proper Makefile and source files |
| 72 | + notes: | |
| 73 | + mkdir -p trinity/postgres/ |
| 74 | + Verify pg_trinity--1.0.sql, pg_trinity.control, trinity.c exist |
| 75 | + |
| 76 | + - name: validate_extension_files |
| 77 | + given: Extension directory with source files |
| 78 | + when: Checking all required files are present |
| 79 | + then: All .control, .sql, and .c files are validated |
| 80 | + notes: | |
| 81 | + Check for: pg_trinity.control, pg_trinity--1.0.sql, trinity.c, Makefile |
| 82 | + Verify file syntax and content |
| 83 | + |
| 84 | + - name: compile_extension_with_pgxs |
| 85 | + given: Valid Makefile with PGXS and source files |
| 86 | + when: Running make with PGXS against PostgreSQL 16 |
| 87 | + then: Extension compiles without errors, produces .so file |
| 88 | + notes: | |
| 89 | + make clean |
| 90 | + make PG_CONFIG=pg_config |
| 91 | + Verify pg_trinity.so is created |
| 92 | + |
| 93 | + - name: handle_compile_warnings |
| 94 | + given: Compilation may produce warnings |
| 95 | + when: Compiling extension with PGXS |
| 96 | + then: Warnings are acknowledged but build succeeds |
| 97 | + notes: | |
| 98 | + Check for -Wmissing-prototypes, -Wdeclaration-after-statement |
| 99 | + Ensure no actual errors block compilation |
| 100 | + |
| 101 | + - name: install_extension_to_pg |
| 102 | + given: Successfully compiled .so file |
| 103 | + when: Running make install with proper privileges |
| 104 | + then: Extension files are copied to PostgreSQL directory |
| 105 | + notes: | |
| 106 | + sudo make install |
| 107 | + OR: make install PG_CONFIG=/usr/local/bin/pg_config |
| 108 | + Files copied to: /usr/lib/postgresql/16/lib/ and /usr/share/postgresql/16/extension/ |
| 109 | + |
| 110 | + - name: verify_installation_files |
| 111 | + given: Extension installed to PostgreSQL directory |
| 112 | + when: Checking .so, .control, and .sql files in pg directories |
| 113 | + then: All files are present and accessible |
| 114 | + notes: | |
| 115 | + ls -la $(pg_config --pkglibdir)/pg_trinity.so |
| 116 | + ls -la $(pg_config --sharedir)/extension/pg_trinity*.control |
| 117 | + ls -la $(pg_config --sharedir)/extension/pg_trinity--*.sql |
| 118 | + |
| 119 | + - name: create_test_database |
| 120 | + given: PostgreSQL server running |
| 121 | + when: Creating dedicated test database |
| 122 | + then: Database 'trinity_test' is ready for extension testing |
| 123 | + notes: | |
| 124 | + createdb trinity_test |
| 125 | + OR: psql -c "CREATE DATABASE trinity_test;" |
| 126 | + |
| 127 | + - name: connect_to_test_database |
| 128 | + given: Test database exists |
| 129 | + when: Establishing psql connection |
| 130 | + then: Interactive session is ready for SQL commands |
| 131 | + notes: | |
| 132 | + psql -d trinity_test |
| 133 | + Verify connection info with \conninfo |
| 134 | + |
| 135 | + - name: create_extension_in_db |
| 136 | + given: Connected to test database |
| 137 | + when: Executing CREATE EXTENSION pg_trinity |
| 138 | + then: Extension is loaded and functions are available |
| 139 | + notes: | |
| 140 | + CREATE EXTENSION pg_trinity; |
| 141 | + Check for any errors in loading shared library |
| 142 | + |
| 143 | + - name: verify_extension_loaded |
| 144 | + given: Extension created in database |
| 145 | + when: Querying pg_extension table |
| 146 | + then: pg_trinity appears in extension list with version 1.0 |
| 147 | + notes: | |
| 148 | + SELECT * FROM pg_extension WHERE extname = 'pg_trinity'; |
| 149 | + Should show: extname, extversion, extrelocatable, extowner |
| 150 | + |
| 151 | + - name: list_available_functions |
| 152 | + given: Extension loaded successfully |
| 153 | + when: Querying pg_proc for extension functions |
| 154 | + then: All trinity_* functions are listed and accessible |
| 155 | + notes: | |
| 156 | + SELECT proname, prorettype::regtype, pronargs |
| 157 | + FROM pg_proc |
| 158 | + WHERE proname LIKE 'trinity_%' |
| 159 | + ORDER BY proname; |
| 160 | + |
| 161 | + - name: test_bind_function |
| 162 | + given: Extension with trinity_bind function available |
| 163 | + when: Executing SELECT trinity_bind(vector_a, vector_b) |
| 164 | + then: Function executes and returns bound vector |
| 165 | + notes: | |
| 166 | + SELECT trinity_bind('[1, -1, 0, 1]'::int[], '[0, 1, -1, 0]'::int[]); |
| 167 | + Verify result is integer array |
| 168 | + |
| 169 | + - name: test_cosine_similarity_function |
| 170 | + given: Extension with trinity_cosine_similarity function |
| 171 | + when: Computing similarity between two vectors |
| 172 | + then: Returns float value between -1.0 and 1.0 |
| 173 | + notes: | |
| 174 | + SELECT trinity_cosine_similarity('[1, 1, 1]'::int[], '[1, 1, 1]'::int[]); |
| 175 | + Should return 1.0 for identical vectors |
| 176 | + |
| 177 | + - name: test_bundle_function |
| 178 | + given: Extension with trinity_bundle function |
| 179 | + when: Bundling multiple vectors together |
| 180 | + then: Returns majority-vote result vector |
| 181 | + notes: | |
| 182 | + SELECT trinity_bundle('[1, 0, -1]'::int[], '[1, 1, 0]'::int[]); |
| 183 | + Verify trit-wise majority logic |
| 184 | + |
| 185 | + - name: test_permute_function |
| 186 | + given: Extension with trinity_permute function |
| 187 | + when: Applying cyclic permutation to vector |
| 188 | + then: Returns rotated vector |
| 189 | + notes: | |
| 190 | + SELECT trinity_permute('[1, 2, 3, 4]'::int[], 1); |
| 191 | + Should shift elements circularly |
| 192 | + |
| 193 | + - name: test_hamming_distance_function |
| 194 | + given: Extension with trinity_hamming_distance function |
| 195 | + when: Computing distance between two vectors |
| 196 | + then: Returns integer count of differing positions |
| 197 | + notes: | |
| 198 | + SELECT trinity_hamming_distance('[1, 1, 1]'::int[], '[1, 1, 1]'::int[]); |
| 199 | + Should return 0 for identical vectors |
| 200 | + |
| 201 | + - name: run_full_test_suite |
| 202 | + given: All functions available and individual tests passing |
| 203 | + when: Executing complete test script |
| 204 | + then: All tests pass, output shows PASS/FAIL for each |
| 205 | + notes: | |
| 206 | + Run SQL test file: psql -d trinity_test -f test/trinity_test.sql |
| 207 | + Capture and verify all test results |
| 208 | + |
| 209 | + - name: verify_extension_tables |
| 210 | + given: Extension that creates tables |
| 211 | + when: Querying information_schema.tables |
| 212 | + then: Extension-specific tables are present |
| 213 | + notes: | |
| 214 | + SELECT tablename FROM pg_tables WHERE schemaname = 'public'; |
| 215 | + Check for any trinity-specific tables |
| 216 | + |
| 217 | + - name: verify_extension_indexes |
| 218 | + given: Extension with indexes |
| 219 | + when: Querying pg_indexes |
| 220 | + then: All indexes are created and valid |
| 221 | + notes: | |
| 222 | + SELECT indexname, tablename FROM pg_indexes WHERE schemaname = 'public'; |
| 223 | + Verify trinity indexes exist |
| 224 | + |
| 225 | + - name: check_extension_dependencies |
| 226 | + given: Extension loaded in database |
| 227 | + when: Querying pg_depend for relationships |
| 228 | + then: All dependencies are satisfied and valid |
| 229 | + notes: | |
| 230 | + Check if extension depends on other extensions |
| 231 | + Verify no circular dependencies |
| 232 | + |
| 233 | + - name: test_error_handling |
| 234 | + given: Extension with error scenarios |
| 235 | + when: Passing invalid inputs (null, wrong types, wrong sizes) |
| 236 | + then: Appropriate error messages are returned |
| 237 | + notes: | |
| 238 | + Test NULL inputs |
| 239 | + Test mismatched array sizes |
| 240 | + Test invalid trit values (not -1, 0, 1) |
| 241 | + |
| 242 | + - name: test_performance_benchmark |
| 243 | + given: Extension with working functions |
| 244 | + when: Executing performance queries with EXPLAIN ANALYZE |
| 245 | + then: Functions complete within acceptable time limits |
| 246 | + notes: | |
| 247 | + EXPLAIN ANALYZE SELECT trinity_bind(...); |
| 248 | + Measure execution time for large vectors (1000+ trits) |
| 249 | + |
| 250 | + - name: cleanup_test_database |
| 251 | + given: Completed testing session |
| 252 | + when: Dropping test database |
| 253 | + then: Database is removed cleanly |
| 254 | + notes: | |
| 255 | + DROP DATABASE trinity_test; |
| 256 | + OR: psql -c "DROP DATABASE trinity_test;" |
| 257 | + |
| 258 | + - name: generate_installation_report |
| 259 | + given: Completed installation and testing |
| 260 | + when: Collecting all metrics and results |
| 261 | + then: Comprehensive report is generated with all details |
| 262 | + notes: | |
| 263 | + Include: build time, install location, test results, performance metrics |
| 264 | + Save to: trinity/postgres/INSTALLATION_REPORT.md |
| 265 | + |
| 266 | + - name: document_extension_api |
| 267 | + given: Working extension with verified functions |
| 268 | + when: Generating API documentation |
| 269 | + then: Complete function reference with signatures and examples |
| 270 | + notes: | |
| 271 | + Document each function: name, parameters, return type, example |
| 272 | + Include: trinity_bind, trinity_cosine_similarity, trinity_bundle, etc. |
| 273 | + Save to: docs/postgres_extension_api.md |
| 274 | + |
| 275 | + - name: verify_production_readiness |
| 276 | + given: All tests passing and documentation complete |
| 277 | + when: Running production readiness checklist |
| 278 | + then: Extension is marked production-ready or issues are identified |
| 279 | + notes: | |
| 280 | + Checklist: error handling, memory management, SQL injection safety, |
| 281 | + performance, documentation, test coverage |
0 commit comments