bigtable 0.6.0

Lib for interfacing with Google BigTable Data API
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
// AIDEV-NOTE: Integration tests for all Bigtable API methods
// These tests require:
// - Credentials file: "Rust Bigtable IAM Admin.json"
// - Project: gen-lang-client-0421059902
// - Instance: test-inst
// - Table: my-table with column family cf1
//
// Run with: cargo test --test integration_tests -- --ignored --test-threads=1

use bigtable::error::BTErr;
use bigtable::method::{
    BigTable, CheckAndMutateRow, ExecuteQuery, GenerateInitialChangeStreamPartitions,
    MutateRow, MutateRows, PingAndWarm, PrepareQuery, ReadChangeStream, ReadModifyWriteRow,
    ReadRows, SampleRowKeys,
};
use bigtable::protos::bigtable::mutate_rows_request;
use bigtable::protos::data::{mutation, row_filter, Mutation, ReadModifyWriteRule, RowFilter, read_modify_write_rule};
use bigtable::request::BTRequest;
use bigtable::support::{Instance, Project, Table};
use bigtable::utils::{encode_str, get_auth_token};
use goauth::auth::Token;
use serde_json::Value;

const CREDENTIALS_FILE: &str = "Rust Bigtable IAM Admin.json";
const PROJECT_ID: &str = "gen-lang-client-0421059902";
const INSTANCE_ID: &str = "test-inst";
const TABLE_NAME: &str = "my-table";
const COLUMN_FAMILY: &str = "cf1";

fn get_token() -> Result<Token, BTErr> {
    get_auth_token(CREDENTIALS_FILE, true)
}

fn get_table() -> Table {
    Table {
        name: String::from(TABLE_NAME),
        instance: Instance {
            name: String::from(INSTANCE_ID),
            project: Project {
                name: String::from(PROJECT_ID),
            },
        },
    }
}

fn is_error_response(response: &Value) -> bool {
    response.get("error").is_some()
}

// Helper to print response for debugging
fn debug_response(name: &str, response: &Value) {
    if is_error_response(response) {
        eprintln!("{} error: {}", name, serde_json::to_string_pretty(response).unwrap());
    } else {
        println!("{} success: {}", name, serde_json::to_string_pretty(response).unwrap());
    }
}

// ============================================================================
// Core Data Operations
// ============================================================================

#[test]
#[ignore]
fn test_read_rows() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: ReadRows::new(),
    };
    req.method.payload_mut().rows_limit = 10;

    let response = req.execute(&token).expect("ReadRows failed");
    debug_response("ReadRows", &response);

    // ReadRows returns empty array [] or array of chunks
    assert!(!is_error_response(&response), "ReadRows returned error");
}

#[test]
#[ignore]
fn test_sample_row_keys() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let req = BTRequest {
        base: None,
        table,
        method: SampleRowKeys::new(),
    };

    let response = req.execute(&token).expect("SampleRowKeys failed");
    debug_response("SampleRowKeys", &response);

    assert!(!is_error_response(&response), "SampleRowKeys returned error");
}

#[test]
#[ignore]
fn test_mutate_row() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: MutateRow::new(),
    };

    let row_key = encode_str("test_row_mutate");

    // Create a SetCell mutation
    let mut set_cell = mutation::SetCell::new();
    set_cell.family_name = String::from(COLUMN_FAMILY);
    set_cell.column_qualifier = encode_str("test_col");
    set_cell.timestamp_micros = -1; // Server assigns timestamp
    set_cell.value = encode_str("test_value_mutate_row");

    let mut m = Mutation::new();
    m.mutation = Some(mutation::Mutation::SetCell(set_cell));

    req.method.payload_mut().row_key = row_key;
    req.method.payload_mut().mutations.push(m);

    let response = req.execute(&token).expect("MutateRow failed");
    debug_response("MutateRow", &response);

    assert!(!is_error_response(&response), "MutateRow returned error");
}

#[test]
#[ignore]
fn test_mutate_rows() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: MutateRows::new(),
    };

    // Create multiple entries
    for i in 0..3 {
        let row_key = encode_str(&format!("test_batch_row_{}", i));

        let mut set_cell = mutation::SetCell::new();
        set_cell.family_name = String::from(COLUMN_FAMILY);
        set_cell.column_qualifier = encode_str("batch_col");
        set_cell.timestamp_micros = -1;
        set_cell.value = encode_str(&format!("batch_value_{}", i));

        let mut m = Mutation::new();
        m.mutation = Some(mutation::Mutation::SetCell(set_cell));

        let mut entry = mutate_rows_request::Entry::new();
        entry.row_key = row_key;
        entry.mutations.push(m);

        req.method.payload_mut().entries.push(entry);
    }

    let response = req.execute(&token).expect("MutateRows failed");
    debug_response("MutateRows", &response);

    assert!(!is_error_response(&response), "MutateRows returned error");
}

#[test]
#[ignore]
fn test_check_and_mutate_row() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: CheckAndMutateRow::new(),
    };

    let row_key = encode_str("test_row_check_mutate");

    // Predicate: pass all (always true)
    let mut predicate_filter = RowFilter::new();
    predicate_filter.filter = Some(row_filter::Filter::PassAllFilter(true));

    // True mutation: set a cell
    let mut set_cell = mutation::SetCell::new();
    set_cell.family_name = String::from(COLUMN_FAMILY);
    set_cell.column_qualifier = encode_str("check_col");
    set_cell.timestamp_micros = -1;
    set_cell.value = encode_str("check_mutate_value");

    let mut m = Mutation::new();
    m.mutation = Some(mutation::Mutation::SetCell(set_cell));

    req.method.payload_mut().row_key = row_key;
    req.method.payload_mut().predicate_filter = Some(predicate_filter).into();
    req.method.payload_mut().true_mutations.push(m);

    let response = req.execute(&token).expect("CheckAndMutateRow failed");
    debug_response("CheckAndMutateRow", &response);

    assert!(!is_error_response(&response), "CheckAndMutateRow returned error");
}

#[test]
#[ignore]
fn test_read_modify_write_row() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: ReadModifyWriteRow::new(),
    };

    let row_key = encode_str("test_row_rmw");

    let mut rule = ReadModifyWriteRule::new();
    rule.family_name = String::from(COLUMN_FAMILY);
    rule.column_qualifier = encode_str("rmw_col");
    rule.rule = Some(read_modify_write_rule::Rule::AppendValue(encode_str("_appended")));

    req.method.payload_mut().row_key = row_key;
    req.method.payload_mut().rules.push(rule);

    let response = req.execute(&token).expect("ReadModifyWriteRow failed");
    debug_response("ReadModifyWriteRow", &response);

    assert!(!is_error_response(&response), "ReadModifyWriteRow returned error");
}

// ============================================================================
// Connection Management
// ============================================================================

#[test]
#[ignore]
fn test_ping_and_warm() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let req = BTRequest {
        base: None,
        table,
        method: PingAndWarm::new(),
    };

    let response = req.execute(&token).expect("PingAndWarm failed");
    debug_response("PingAndWarm", &response);

    assert!(!is_error_response(&response), "PingAndWarm returned error");
}

// ============================================================================
// Change Streams (CDC)
// ============================================================================

#[test]
#[ignore]
fn test_generate_initial_change_stream_partitions() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let req = BTRequest {
        base: None,
        table,
        method: GenerateInitialChangeStreamPartitions::new(),
    };

    let response = req.execute(&token).expect("GenerateInitialChangeStreamPartitions failed");
    debug_response("GenerateInitialChangeStreamPartitions", &response);

    // This may return error if change streams not enabled on table - that's OK
    // We're testing that the API call works
    println!("GenerateInitialChangeStreamPartitions response received");
}

#[test]
#[ignore]
fn test_read_change_stream() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let req = BTRequest {
        base: None,
        table,
        method: ReadChangeStream::new(),
    };

    let response = req.execute(&token).expect("ReadChangeStream failed");
    debug_response("ReadChangeStream", &response);

    // This may return error if change streams not enabled - that's OK
    println!("ReadChangeStream response received");
}

// ============================================================================
// SQL Queries (GoogleSQL)
// ============================================================================

#[test]
#[ignore]
fn test_execute_query() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: ExecuteQuery::new(),
    };

    // Simple query - note: GoogleSQL support may vary by table config
    req.method.payload_mut().query = String::from("SELECT * FROM `my-table` LIMIT 1");

    let response = req.execute(&token).expect("ExecuteQuery failed");
    debug_response("ExecuteQuery", &response);

    // SQL queries may not be enabled - that's OK for API testing
    println!("ExecuteQuery response received");
}

#[test]
#[ignore]
fn test_prepare_query() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    let mut req = BTRequest {
        base: None,
        table,
        method: PrepareQuery::new(),
    };

    req.method.payload_mut().query = String::from("SELECT * FROM `my-table` LIMIT 1");

    let response = req.execute(&token).expect("PrepareQuery failed");
    debug_response("PrepareQuery", &response);

    // SQL queries may not be enabled - that's OK for API testing
    println!("PrepareQuery response received");
}

// ============================================================================
// End-to-End Test: Write then Read
// ============================================================================

#[test]
#[ignore]
fn test_write_then_read() {
    let token = get_token().expect("Failed to get token");
    let table = get_table();

    // 1. Write a row
    let test_row_key = "e2e_test_row";
    let test_value = "e2e_test_value_12345";

    let mut write_req = BTRequest {
        base: None,
        table: table.clone(),
        method: MutateRow::new(),
    };

    let mut set_cell = mutation::SetCell::new();
    set_cell.family_name = String::from(COLUMN_FAMILY);
    set_cell.column_qualifier = encode_str("e2e_col");
    set_cell.timestamp_micros = -1;
    set_cell.value = encode_str(test_value);

    let mut m = Mutation::new();
    m.mutation = Some(mutation::Mutation::SetCell(set_cell));

    write_req.method.payload_mut().row_key = encode_str(test_row_key);
    write_req.method.payload_mut().mutations.push(m);

    let write_response = write_req.execute(&token).expect("Write failed");
    assert!(!is_error_response(&write_response), "Write returned error");
    println!("Write succeeded");

    // 2. Read it back
    let mut read_req = BTRequest {
        base: None,
        table,
        method: ReadRows::new(),
    };
    read_req.method.payload_mut().rows_limit = 100;

    let read_response = read_req.execute(&token).expect("Read failed");
    assert!(!is_error_response(&read_response), "Read returned error");

    // Verify the response contains our data
    let response_str = serde_json::to_string(&read_response).unwrap();
    println!("Read response: {}", response_str);

    // The response should contain our row key (base64 encoded)
    // This is a basic check - the actual response format is complex
    assert!(read_response.is_array() || read_response.is_object(),
            "Expected array or object response");
}