aperture-cli 0.1.9

Dynamic CLI generator for OpenAPI specifications
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

use aperture_cli::cache::models::{CachedCommand, CachedSpec, PaginationInfo};
use aperture_cli::suggestions::{
    suggest_auth_fix, suggest_parameter_format, suggest_similar_operations, suggest_valid_values,
};
use std::collections::HashMap;

fn create_test_spec() -> CachedSpec {
    CachedSpec {
        cache_format_version: aperture_cli::cache::models::CACHE_FORMAT_VERSION,
        name: "test-api".to_string(),
        version: "1.0.0".to_string(),
        commands: vec![
            CachedCommand {
                name: "get-user".to_string(),
                description: Some("Get user by ID".to_string()),
                summary: None,
                operation_id: "getUserById".to_string(),
                method: "GET".to_string(),
                path: "/users/{id}".to_string(),
                parameters: vec![],
                request_body: None,
                responses: vec![],
                security_requirements: vec![],
                tags: vec!["users".to_string()],
                deprecated: false,
                external_docs_url: None,
                examples: vec![],
                display_group: None,
                display_name: None,
                aliases: vec![],
                hidden: false,
                pagination: PaginationInfo::default(),
            },
            CachedCommand {
                name: "create-user".to_string(),
                description: Some("Create a new user".to_string()),
                summary: None,
                operation_id: "createUser".to_string(),
                method: "POST".to_string(),
                path: "/users".to_string(),
                parameters: vec![],
                request_body: None,
                responses: vec![],
                security_requirements: vec![],
                tags: vec!["users".to_string()],
                deprecated: false,
                external_docs_url: None,
                examples: vec![],
                display_group: None,
                display_name: None,
                aliases: vec![],
                hidden: false,
                pagination: PaginationInfo::default(),
            },
            CachedCommand {
                name: "list-users".to_string(),
                description: Some("List all users".to_string()),
                summary: None,
                operation_id: "listUsers".to_string(),
                method: "GET".to_string(),
                path: "/users".to_string(),
                parameters: vec![],
                request_body: None,
                responses: vec![],
                security_requirements: vec![],
                tags: vec!["users".to_string()],
                deprecated: false,
                external_docs_url: None,
                examples: vec![],
                display_group: None,
                display_name: None,
                aliases: vec![],
                hidden: false,
                pagination: PaginationInfo::default(),
            },
        ],
        base_url: Some("https://api.example.com".to_string()),
        servers: vec!["https://api.example.com".to_string()],
        security_schemes: HashMap::new(),
        skipped_endpoints: vec![],
        server_variables: HashMap::new(),
    }
}

#[test]
fn test_suggest_similar_operations() {
    let spec = create_test_spec();

    // Test fuzzy matching for typos - search for something more unique
    let suggestions = suggest_similar_operations(&spec, "getUserById");
    println!("Suggestions for 'getUserById': {suggestions:?}");
    assert!(
        !suggestions.is_empty(),
        "Expected suggestions for 'getUserById', got none"
    );
    assert!(
        suggestions[0].contains("get-user-by-id"),
        "Expected first suggestion to contain 'get-user-by-id', got: {}",
        suggestions[0]
    );

    // Test partial matching
    let suggestions = suggest_similar_operations(&spec, "list");
    println!("Suggestions for 'list': {suggestions:?}");
    assert!(!suggestions.is_empty());
    assert!(suggestions[0].contains("list-users")); // Should match list-users

    // Test with completely unrelated term - fuzzy matching should still find something
    let suggestions = suggest_similar_operations(&spec, "xyz123");
    println!("Suggestions for 'xyz123': {suggestions:?}");
    // Fuzzy matching may or may not return results for completely unrelated terms
    // so we'll just check the function doesn't crash
}

#[test]
fn test_suggest_parameter_format() {
    let suggestion = suggest_parameter_format("user-id", Some("integer"));
    assert_eq!(suggestion, "--user-id <integer>");

    let suggestion = suggest_parameter_format("name", None);
    assert_eq!(suggestion, "--name <value>");
}

#[test]
fn test_suggest_valid_values() {
    let values = vec![
        "active".to_string(),
        "inactive".to_string(),
        "pending".to_string(),
    ];
    let suggestion = suggest_valid_values("status", &values);
    assert!(suggestion.contains("'active'"));
    assert!(suggestion.contains("'inactive'"));
    assert!(suggestion.contains("'pending'"));

    // Test with many values
    let many_values: Vec<String> = (0..10).map(|i| format!("value{i}")).collect();
    let suggestion = suggest_valid_values("field", &many_values);
    assert!(suggestion.contains("..."));
    assert!(suggestion.contains("value0"));
    assert!(!suggestion.contains("value9")); // Should be truncated

    // Test with no values
    let suggestion = suggest_valid_values("field", &[]);
    assert!(suggestion.contains("Check the parameter documentation"));
}

#[test]
fn test_suggest_auth_fix() {
    let suggestion = suggest_auth_fix("api-key", Some("API_KEY"));
    assert!(suggestion.contains("API_KEY"));
    assert!(suggestion.contains("aperture config secrets"));

    let suggestion = suggest_auth_fix("oauth", None);
    assert!(suggestion.contains("oauth"));
    assert!(suggestion.contains("aperture config secrets"));
}