spikard-cli 0.17.0-rc.1

Command-line interface for building and validating Spikard applications
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
#![allow(
    clippy::needless_raw_string_hashes,
    clippy::doc_markdown,
    clippy::uninlined_format_args,
    reason = "GraphQL schemas contain identifiers like ID! that need raw strings"
)]

//! Full integration tests for Python GraphQL code generation
//!
//! Validates that the Python generator produces code conforming to CLAUDE.md requirements:
//! - Python 3.10+ syntax (union types with |, not Optional)
//! - msgspec.Struct with frozen=True, kw_only=True
//! - Type hints: list[T] not List[T]
//! - Snake_case field name conversion
//! - NumPy-style docstrings
//! - Ariadne schema binding
//! - Async resolver functions

use anyhow::Result;
use spikard_cli::codegen::generate_python_graphql;

/// Test 1: Helper methods - map_scalar_type
#[test]
fn test_python_scalar_type_mapping() -> Result<()> {
    let schema = r"
        type Query {
            name: String!
            count: Int!
            percentage: Float!
            active: Boolean!
            id: ID!
        }
        type User {
            name: String!
            count: Int!
            percentage: Float!
            active: Boolean!
            id: ID!
        }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(result.contains("name: str"), "String should map to str");
    assert!(result.contains("count: int"), "Int should map to int");
    assert!(result.contains("percentage: float"), "Float should map to float");
    assert!(result.contains("active: bool"), "Boolean should map to bool");
    assert!(result.contains("id: str"), "ID should map to str");

    Ok(())
}

/// Test 2: Helper methods - map_type_with_list_item_nullability
#[test]
fn test_python_type_nullability_handling() -> Result<()> {
    let schema = r"
        type Query {
            required: [String!]!
            nullable: [String!]
            listOfNullable: [String]!
            allNullable: [String]
        }
        type TestType {
            id: ID!
        }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(result.contains("#!/usr/bin/env python3"), "Python header required");
    assert!(!result.is_empty(), "Should generate output");

    Ok(())
}

/// Test 3: Helper methods - to_snake_case
#[test]
fn test_python_snake_case_conversion() -> Result<()> {
    let schema = r"
        type Query {
            getUser(userId: ID!): User
            createUserProfile(input: String!): User
            HTTPStatus: String
        }
        type User {
            id: ID!
            firstName: String!
        }
    ";

    let result = generate_python_graphql(schema, "resolvers")?;

    assert!(
        result.contains("resolve_get_user") || result.contains("get_user"),
        "getUser should convert to get_user or similar"
    );
    assert!(
        result.contains("resolve_create_user_profile") || result.contains("create_user_profile"),
        "createUserProfile should convert to create_user_profile or similar"
    );

    Ok(())
}

/// Test 4: Helper methods - reconstruct_sdl
#[test]
fn test_python_reconstruct_sdl() -> Result<()> {
    let schema = r#"
        """A user in the system """
        type User {
            """User ID """
            id: ID!
            """User name """
            name: String!
        }
        type Query {
            user(id: ID!): User
        }
    "#;

    let result = generate_python_graphql(schema, "schema")?;

    assert!(result.contains("type_defs"), "SDL should be assigned to type_defs");
    assert!(result.contains("type Query"), "Query type should be in SDL");
    assert!(result.contains("type User"), "User type should be in SDL");
    assert!(
        result.contains("make_executable_schema"),
        "Ariadne schema should be created"
    );

    Ok(())
}

/// Test 5: generate_types() - Object types
#[test]
fn test_python_generate_object_types() -> Result<()> {
    let schema = r#"
        """A user in the system """
        type User {
            """Unique identifier """
            id: ID!
            """User display name """
            name: String!
            """Optional email address """
            email: String
        }
        type Query { user: User }
    "#;

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("class User(Struct, frozen=True, kw_only=True):"),
        "User should be msgspec.Struct with frozen=True, kw_only=True"
    );

    assert!(
        result.contains("\"\"\"A user in the system\"\"\"") || result.contains("class User"),
        "Should have NumPy-style docstring"
    );

    assert!(result.contains("id: str"), "id field should have str type");
    assert!(result.contains("name: str"), "name field should have str type");
    assert!(
        result.contains("email: str | None"),
        "nullable email should use | None (not Optional)"
    );

    assert!(result.contains("from msgspec import Struct"), "msgspec import required");

    Ok(())
}

/// Test 6: generate_types() - Enums
#[test]
fn test_python_generate_enum_types() -> Result<()> {
    let schema = r#"
        """User status enumeration """
        enum UserStatus {
            """Active user """
            ACTIVE
            """Inactive user """
            INACTIVE
            """Pending approval """
            PENDING
        }
        type Query { status: UserStatus! }
    "#;

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("class UserStatus(str, Enum):"),
        "Should generate enum as (str, Enum)"
    );
    assert!(result.contains("ACTIVE = \"ACTIVE\""), "enum value mapping required");
    assert!(
        result.contains("INACTIVE = \"INACTIVE\""),
        "enum value mapping required"
    );
    assert!(result.contains("PENDING = \"PENDING\""), "enum value mapping required");

    assert!(
        result.contains("\"\"\"User status enumeration\"\"\"") || result.contains("class UserStatus"),
        "Should have NumPy-style docstring"
    );

    assert!(result.contains("from enum import Enum"), "Enum import required");

    Ok(())
}

/// Test 7: generate_types() - Input types
#[test]
fn test_python_generate_input_types() -> Result<()> {
    let schema = r#"
        """Input for creating a user """
        input CreateUserInput {
            """User's full name """
            name: String!
            """User's email address """
            email: String!
            """Optional age """
            age: Int
        }
        type Query { dummy: String }
    "#;

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("class CreateUserInput(Struct, frozen=True, kw_only=True):"),
        "Input should be msgspec.Struct with frozen=True, kw_only=True"
    );

    assert!(result.contains("name: str"), "required field should not be nullable");
    assert!(result.contains("email: str"), "required field should not be nullable");
    assert!(result.contains("age: int | None"), "nullable field should use | None");

    Ok(())
}

/// Test 8: generate_types() - Union types
#[test]
fn test_python_generate_union_types() -> Result<()> {
    let schema = r"
        type User { id: ID! name: String! }
        type Post { id: ID! title: String! }
        type Comment { id: ID! text: String! }
        union SearchResult = User | Post | Comment
        type Query { search: SearchResult }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("SearchResult =") || result.contains("SearchResult:"),
        "Union should be represented as type alias"
    );

    assert!(
        result.contains("class User") || result.contains("User"),
        "User type should be present"
    );
    assert!(
        result.contains("class Post") || result.contains("Post"),
        "Post type should be present"
    );

    Ok(())
}

/// Test 9: generate_types() - Scalar type aliases
#[test]
fn test_python_generate_scalar_aliases() -> Result<()> {
    let schema = r"
        scalar DateTime
        scalar JSON
        scalar UUID

        type User {
            id: UUID!
            name: String!
            createdAt: DateTime!
            metadata: JSON
        }

        type Query {
            user(id: UUID!): User
        }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(result.contains("#!/usr/bin/env python3"), "shebang required");
    assert!(
        result.contains("from msgspec import Struct"),
        "should import msgspec.Struct for custom types"
    );

    assert!(result.contains("class User(Struct"), "should generate User class");

    assert!(result.contains("id: str"), "UUID should map to str");
    assert!(result.contains("name: str"), "String should map to str");
    assert!(result.contains("createdAt: str"), "DateTime should map to str");
    assert!(
        result.contains("metadata: str | None"),
        "JSON should map to str | None (nullable)"
    );

    Ok(())
}

/// Test 10: generate_resolvers() - Query resolvers
#[test]
fn test_python_generate_query_resolvers() -> Result<()> {
    let schema = r#"
        type Query {
            """Get user by ID """
            user(id: ID!, name: String): User
            """List all users """
            users(limit: Int, offset: Int): [User!]!
        }
        type User { id: ID! name: String! }
    "#;

    let result = generate_python_graphql(schema, "resolvers")?;

    assert!(
        result.contains("async def resolve_user") || result.contains("async def"),
        "resolvers should be async"
    );

    assert!(!result.contains("Optional["), "should not use Optional (Python 3.10+)");

    assert!(
        result.contains("id:") || result.contains("User"),
        "resolver signature should include arguments and return type"
    );

    assert!(
        result.contains("NotImplementedError") || result.contains("pass"),
        "resolver body should have placeholder"
    );

    Ok(())
}

/// Test 11: generate_resolvers() - Mutation resolvers
#[test]
fn test_python_generate_mutation_resolvers() -> Result<()> {
    let schema = r#"
        type Query { dummy: String }
        type Mutation {
            """Create a new user """
            createUser(input: CreateUserInput!): User!
            """Update user """
            updateUser(id: ID!, name: String!): User
        }
        input CreateUserInput {
            name: String!
            email: String!
        }
        type User { id: ID! name: String! }
    "#;

    let result = generate_python_graphql(schema, "resolvers")?;

    assert!(
        result.contains("async def resolve_create_user") || result.contains("create_user"),
        "createUser resolver should exist"
    );
    assert!(
        result.contains("async def resolve_update_user") || result.contains("update_user"),
        "updateUser resolver should exist"
    );

    Ok(())
}

/// Test 12: generate_schema_definition() - Ariadne setup
#[test]
fn test_python_generate_ariadne_schema() -> Result<()> {
    let schema = r"
        type Query {
            hello: String!
            user(id: ID!): User
        }
        type Mutation {
            createUser(name: String!): User!
        }
        type User {
            id: ID!
            name: String!
        }
    ";

    let result = generate_python_graphql(schema, "schema")?;

    assert!(
        result.contains("from ariadne import make_executable_schema"),
        "Ariadne imports required"
    );
    assert!(
        result.contains("QueryType") || result.contains("query ="),
        "QueryType setup required"
    );
    assert!(
        result.contains("MutationType") || result.contains("mutation ="),
        "MutationType setup required"
    );

    assert!(
        result.contains("make_executable_schema"),
        "make_executable_schema call required"
    );
    assert!(result.contains("type_defs"), "type_defs variable required");
    assert!(result.contains("schema ="), "schema variable required");

    assert!(
        result.contains("__all__") || result.contains("schema"),
        "schema should be accessible"
    );

    Ok(())
}

/// Test 13: Complete output generation
#[test]
fn test_python_complete_output() -> Result<()> {
    let schema = r#"
        """User type """
        type User {
            """User ID """
            id: ID!
            """User name """
            name: String!
        }

        """Create user input """
        input CreateUserInput {
            name: String!
        }

        type Query {
            """Get user """
            user(id: ID!): User
        }

        type Mutation {
            """Create user """
            createUser(input: CreateUserInput!): User!
        }
    "#;

    let result = generate_python_graphql(schema, "all")?;

    assert!(
        result.contains("class User") || result.contains("type User"),
        "types section required"
    );
    assert!(
        result.contains("async def") || result.contains("resolve_"),
        "resolvers section required"
    );
    assert!(
        result.contains("make_executable_schema") || result.contains("type_defs"),
        "schema section required"
    );

    Ok(())
}

/// Test 14: Deprecation handling with NumPy docstrings
#[test]
fn test_python_deprecation_with_docstrings() -> Result<()> {
    let schema = r#"
        type Query {
            """Old field - use newField instead """
            oldField: String @deprecated(reason: "Use newField instead")
            """New field """
            newField: String!
        }
    "#;

    let result = generate_python_graphql(schema, "resolvers")?;

    assert!(
        result.contains("resolve_old_field") || result.contains("old_field"),
        "deprecated field resolver should exist"
    );
    assert!(
        result.contains("resolve_new_field") || result.contains("new_field"),
        "new field resolver should exist"
    );

    Ok(())
}

/// Test 15: Complex nested types
#[test]
fn test_python_complex_nested_types() -> Result<()> {
    let schema = r"
        type User {
            id: ID!
            posts: [Post!]!
            profile: Profile
        }
        type Post {
            id: ID!
            title: String!
            author: User!
        }
        type Profile {
            bio: String
            avatar: String
        }
        type Query {
            user(id: ID!): User
        }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("class User") || result.contains("User"),
        "User type required"
    );
    assert!(
        result.contains("class Post") || result.contains("Post"),
        "Post type required"
    );
    assert!(
        result.contains("class Profile") || result.contains("Profile"),
        "Profile type required"
    );

    assert!(
        result.contains("list[") || result.contains('['),
        "list notation should be Python 3.10+ style (list[T])"
    );

    Ok(())
}

/// Test 16: Proper header and imports
#[test]
fn test_python_header_and_imports() -> Result<()> {
    let schema = r"
        type Query { hello: String! }
        type User { id: ID! }
    ";

    let types_result = generate_python_graphql(schema, "types")?;
    assert!(types_result.contains("#!/usr/bin/env python3"), "shebang required");
    assert!(
        types_result.contains("\"\"\"GraphQL types generated from schema.\"\"\""),
        "module docstring required"
    );

    let resolvers_result = generate_python_graphql(schema, "resolvers")?;
    assert!(resolvers_result.contains("#!/usr/bin/env python3"), "shebang required");
    assert!(
        resolvers_result.contains("\"\"\"GraphQL resolver functions.\"\"\""),
        "module docstring required"
    );

    let schema_result = generate_python_graphql(schema, "schema")?;
    assert!(
        schema_result.contains("# GraphQL Schema Definition") || schema_result.contains("type_defs"),
        "schema definition header required"
    );

    Ok(())
}

/// Test 17: Edge case - minimal types
#[test]
fn test_python_empty_types_with_pass() -> Result<()> {
    let schema = r"
        type Query { dummy: String }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(result.contains("#!/usr/bin/env python3"), "basic structure required");

    Ok(())
}

/// Test 18: Proper Struct configuration following CLAUDE.md
#[test]
fn test_python_struct_configuration_per_claude() -> Result<()> {
    let schema = r"
        type User {
            id: ID!
            name: String!
        }
        type Query { user: User }
    ";

    let result = generate_python_graphql(schema, "types")?;

    assert!(
        result.contains("class User(Struct, frozen=True, kw_only=True):"),
        "User must be Struct with frozen=True, kw_only=True as per CLAUDE.md"
    );

    Ok(())
}

/// Test 19: Fix for Any type removal - CRITICAL requirement
/// Ensures generated Python code has NO Any type usage
#[test]
fn test_python_no_any_type_usage() -> Result<()> {
    let schema = r"
        type Query {
            user(id: ID!, name: String): User
            users(limit: Int, offset: Int): [User!]!
        }
        type User {
            id: ID!
            name: String!
            email: String
        }
        type Post {
            id: ID!
            title: String!
        }
        union SearchResult = User | Post
    ";

    let resolvers = generate_python_graphql(schema, "resolvers")?;

    assert!(
        !resolvers.contains("from typing import Any"),
        "Resolvers MUST NOT import Any type"
    );

    assert!(
        resolvers.contains("from typing import TYPE_CHECKING"),
        "Resolvers must gate type-only imports behind TYPE_CHECKING"
    );
    assert!(
        resolvers.contains("from graphql import GraphQLResolveInfo"),
        "Resolvers must import GraphQLResolveInfo for type annotations"
    );

    assert!(
        resolvers.contains("parent: dict[str, object]"),
        "Resolver parent parameter must be dict[str, object] (not Any)"
    );
    assert!(
        resolvers.contains("info: GraphQLResolveInfo"),
        "Resolver info parameter must be GraphQLResolveInfo (not Any)"
    );

    let types = generate_python_graphql(schema, "types")?;

    assert!(
        !types.contains("from typing import Any"),
        "Types MUST NOT import Any type"
    );

    assert!(
        types.contains("SearchResult: TypeAlias = \"User | Post\"")
            || types.contains("SearchResult: TypeAlias = \"Post | User\""),
        "Union must be 'SearchResult: TypeAlias = \"User | Post\"' (NOT with Any)"
    );

    assert!(
        !types.contains("Optional["),
        "Must use | None syntax (Python 3.10+), NOT Optional"
    );

    Ok(())
}