mylangiser 0.1.0

Generate progressive-disclosure interfaces from complex APIs via My-Lang
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

// Mylangiser Integration Tests
// SPDX-License-Identifier: PMPL-1.0-or-later
// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
//
// Verify that the Zig FFI correctly implements the Idris2 ABI for
// progressive-disclosure layer generation.

const std = @import("std");
const testing = std.testing;

// Import FFI functions
extern fn mylangiser_init() ?*opaque {};
extern fn mylangiser_free(?*opaque {}) void;
extern fn mylangiser_analyse_surface(?*opaque {}, ?[*]const u8, u32) c_int;
extern fn mylangiser_endpoint_count(?*opaque {}) u32;
extern fn mylangiser_compute_scores(?*opaque {}) c_int;
extern fn mylangiser_get_score(?*opaque {}, u32) u32;
extern fn mylangiser_generate_layers(?*opaque {}) c_int;
extern fn mylangiser_get_level(?*opaque {}, u32) u32;
extern fn mylangiser_default_count(?*opaque {}, u32) u32;
extern fn mylangiser_get_string(?*opaque {}) ?[*:0]const u8;
extern fn mylangiser_free_string(?[*:0]const u8) void;
extern fn mylangiser_last_error() ?[*:0]const u8;
extern fn mylangiser_version() [*:0]const u8;
extern fn mylangiser_is_initialized(?*opaque {}) u32;

//==============================================================================
// Lifecycle Tests
//==============================================================================

test "create and destroy handle" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    try testing.expect(handle != null);
}

test "handle is initialized" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const initialized = mylangiser_is_initialized(handle);
    try testing.expectEqual(@as(u32, 1), initialized);
}

test "null handle is not initialized" {
    const initialized = mylangiser_is_initialized(null);
    try testing.expectEqual(@as(u32, 0), initialized);
}

//==============================================================================
// API Surface Analysis Tests
//==============================================================================

test "analyse surface with null handle returns null_pointer" {
    const result = mylangiser_analyse_surface(null, null, 0);
    try testing.expectEqual(@as(c_int, 4), result); // 4 = null_pointer
}

test "analyse surface with null buffer returns null_pointer" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const result = mylangiser_analyse_surface(handle, null, 10);
    try testing.expectEqual(@as(c_int, 4), result); // 4 = null_pointer
}

test "analyse surface with empty buffer returns invalid_param" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const buf = "x";
    const result = mylangiser_analyse_surface(handle, buf.ptr, 0);
    try testing.expectEqual(@as(c_int, 2), result); // 2 = invalid_param
}

test "endpoint count is zero before analysis" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const count = mylangiser_endpoint_count(handle);
    try testing.expectEqual(@as(u32, 0), count);
}

//==============================================================================
// Complexity Scoring Tests
//==============================================================================

test "compute scores on empty endpoint list succeeds" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const result = mylangiser_compute_scores(handle);
    try testing.expectEqual(@as(c_int, 0), result); // 0 = ok
}

test "compute scores with null handle returns error" {
    const result = mylangiser_compute_scores(null);
    try testing.expectEqual(@as(c_int, 4), result); // 4 = null_pointer
}

test "get score for out-of-range index returns zero" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    _ = mylangiser_compute_scores(handle);
    const score = mylangiser_get_score(handle, 999);
    try testing.expectEqual(@as(u32, 0), score);
}

//==============================================================================
// Layer Generation Tests
//==============================================================================

test "generate layers without scores returns error" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const result = mylangiser_generate_layers(handle);
    try testing.expectEqual(@as(c_int, 1), result); // 1 = error (scores not computed)
}

test "generate layers after scoring succeeds" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    _ = mylangiser_compute_scores(handle);
    const result = mylangiser_generate_layers(handle);
    try testing.expectEqual(@as(c_int, 0), result); // 0 = ok
}

test "default count for out-of-range index returns zero" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    _ = mylangiser_compute_scores(handle);
    _ = mylangiser_generate_layers(handle);
    const count = mylangiser_default_count(handle, 999);
    try testing.expectEqual(@as(u32, 0), count);
}

//==============================================================================
// String Tests
//==============================================================================

test "get string result" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    const str = mylangiser_get_string(handle);
    defer if (str) |s| mylangiser_free_string(s);

    try testing.expect(str != null);
}

test "get string with null handle" {
    const str = mylangiser_get_string(null);
    try testing.expect(str == null);
}

//==============================================================================
// Error Handling Tests
//==============================================================================

test "last error after null handle operation" {
    _ = mylangiser_analyse_surface(null, null, 0);

    const err = mylangiser_last_error();
    try testing.expect(err != null);

    if (err) |e| {
        const err_str = std.mem.span(e);
        try testing.expect(err_str.len > 0);
    }
}

test "no error after successful operation" {
    const handle = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(handle);

    _ = mylangiser_compute_scores(handle);
    // Error should be cleared after successful operation
}

//==============================================================================
// Version Tests
//==============================================================================

test "version string is not empty" {
    const ver = mylangiser_version();
    const ver_str = std.mem.span(ver);

    try testing.expect(ver_str.len > 0);
}

test "version string is semantic version format" {
    const ver = mylangiser_version();
    const ver_str = std.mem.span(ver);

    // Should be in format X.Y.Z
    try testing.expect(std.mem.count(u8, ver_str, ".") >= 1);
}

//==============================================================================
// Memory Safety Tests
//==============================================================================

test "multiple handles are independent" {
    const h1 = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(h1);

    const h2 = mylangiser_init() orelse return error.InitFailed;
    defer mylangiser_free(h2);

    try testing.expect(h1 != h2);

    // Operations on h1 should not affect h2
    _ = mylangiser_compute_scores(h1);
    _ = mylangiser_compute_scores(h2);
}

test "free null is safe" {
    mylangiser_free(null); // Should not crash
}