a2kit 4.4.2

Retro disk image and language utility
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

use predicates::prelude::*; // Used for writing assertions
use assert_cmd::cargo; // Run programs
use std::path::PathBuf;
use tempfile;
type STDRESULT = Result<(),Box<dyn std::error::Error>>;

const EXPECTED_BAS: &str = r#"10 D$ =  CHR$ (4)
20  INPUT "(S)MALL, (B)IG, (R)ENAME/DELETE? ";A$
30  IF A$ = "S" THEN 1000
40  IF A$ = "B" OR A$ = "R" THEN 2000
50  PRINT "INVALID CHOICE"
60  END 
1000  POKE 768,6: POKE 769,5: POKE 770,0: POKE 771,2
1010  PRINT D$;"BSAVE THECHIP,A768,L4"
1020  PRINT D$;"OPEN THETEXT"
1030  PRINT D$;"WRITE THETEXT"
1040  PRINT "HELLO FROM EMULATOR"
1050  PRINT D$;"CLOSE THETEXT"
1999  END 
2000  PRINT D$;"OPEN TREE1,L128"
2010  PRINT D$;"WRITE TREE1,R2000"
2020  PRINT "HELLO FROM TREE 1"
2030  PRINT D$;"CLOSE TREE1"
2040  PRINT D$;"OPEN TREE2,L127"
2050  PRINT D$;"WRITE TREE2,R2000"
2060  PRINT "HELLO FROM TREE 2"
2070  PRINT D$;"WRITE TREE2,R4000"
2080  PRINT "HELLO FROM TREE 2"
2090  PRINT D$;"CLOSE TREE2"
2100  FOR I = 16384 TO 32767: POKE I,256 * ((I - 16384) / 256 -  INT ((I - 16384) / 256)): NEXT 
2110  PRINT D$;"BSAVE SAPLING,A16384,L16384"
2120  IF A$ = "B" THEN  END 
2130  PRINT D$;"DELETE TREE2"
2140  PRINT D$;"RENAME SAPLING,SAP"
2150  PRINT D$;"RENAME TREE1,MYTREE1"
2160  END 
"#;

const EXPECTED_TOKS: &str = r#"
16 08 0A 00 97 3A B2 20 74 65 73 74 20 70 72 6F
67 72 61 6D 00 2A 08 14 00 BA 22 54 45 53 54 20
50 52 4F 47 52 41 4D 22 00 33 08 1E 00 B0 31 30
30 00 39 08 28 00 80 00 57 08 64 00 84 22 45 4E
54 45 52 20 22 3B 41 42 52 41 43 41 44 41 42 52
41 2C 42 2C 43 00 65 08 6E 00 BA 41 3B 42 3B 43
3A 3A BA 00 6B 08 78 00 B1 00 7D 08 82 00 B2 20
75 6E 72 65 61 63 68 61 62 6C 65 00 8B 08 8C 00
AD 41 41 31 32 33 C4 31 30 00 AC 08 96 00 AF 28
22 41 42 52 41 43 41 44 41 42 52 41 22 2C 41 42
52 41 43 41 44 41 42 52 41 29 00 00 00"#;

#[test]
fn no_match() -> STDRESULT {
    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_glob = PathBuf::from("tests").join("prodos-bigfiles.woz/neverwas");
    cmd.arg("cp").arg(dimg_glob).arg(dir.path())
        .assert()
        .failure()
        .stderr(predicate::str::contains("no matches"));

    Ok(())
}

#[test]
fn rename_invalid_name() -> STDRESULT {
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("prodos.do");
    let host_path = dir.path().join("bad-name");
    let renamed_path = dir.path().join("prodos.do/bad.name");
    std::fs::write(&host_path,vec![1,2,3]).expect("write failed");
    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("mkdsk")
        .arg("-v").arg("new.disk").arg("-t").arg("do").arg("-o").arg("prodos")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    // using the plain disk image as destination should fail
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp").arg(&host_path).arg(dimg_path.clone()).assert().failure();

    // using the destination with the new filename specified should succeed
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp").arg(&host_path).arg(renamed_path.clone()).assert().success();

    Ok(())
}

#[test]
fn host_to_do() -> STDRESULT {
    
    // make a disk image in the temp directory

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("dos33.do");
    let host_path = PathBuf::from("tests").join("applesoft").join("test.bas");
    cmd.arg("mkdsk")
        .arg("-v").arg("254").arg("-t").arg("do").arg("-o").arg("dos33")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    // smart copy an Applesoft source to the image

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp").arg(host_path).arg(dimg_path.clone()).assert().success();

    // check catalog

    let expected = 
r#"DISK VOLUME 254

 A 002 TEST"#;
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("catalog")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success()
        .stdout(predicate::str::contains(expected));

    // check tokens

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("get")
        .arg("-d").arg(dimg_path)
        .arg("-t").arg("atok")
        .arg("-f").arg("test")
        .assert()
        .success()
        .stdout(predicate::eq(hex::decode(EXPECTED_TOKS
            .replace(" ","")
            .replace("\n","")
            .replace("\r",""))?));

    Ok(())
}

#[test]
fn basic_to_host() -> STDRESULT {
    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_glob = PathBuf::from("tests").join("prodos-bigfiles.woz/hello");
    cmd.arg("cp").arg(dimg_glob).arg(dir.path())
        .assert()
        .success();
    let actual_bas = String::from_utf8(std::fs::read(&dir.path().join("HELLO"))?)?;
    assert_eq!(&actual_bas,EXPECTED_BAS);
    Ok(())
}

#[test]
fn glob_recs_to_host() -> STDRESULT {
    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_glob = PathBuf::from("tests").join("prodos-bigfiles.woz/tree*");
    cmd.arg("cp").arg(dimg_glob).arg(dir.path())
        .assert()
        .success();
    let expected_tree1 = r#"{"fimg_type":"rec","record_length":128,"records":{"2000":["HELLO FROM TREE 1"]}}"#;
    // the records can come out in any order, with only 2 we can just explicitly check both possibilities
    let expected_tree2_1 = r#"{"fimg_type":"rec","record_length":127,"records":{"2000":["HELLO FROM TREE 2"],"4000":["HELLO FROM TREE 2"]}}"#;
    let expected_tree2_2 = r#"{"fimg_type":"rec","record_length":127,"records":{"4000":["HELLO FROM TREE 2"],"2000":["HELLO FROM TREE 2"]}}"#;
    let tree1 = String::from_utf8(std::fs::read(&dir.path().join("TREE1"))?)?;
    let tree2 = String::from_utf8(std::fs::read(&dir.path().join("TREE2"))?)?;
    assert_eq!(&tree1,expected_tree1);
    let tst = predicate::in_iter(vec![expected_tree2_1,expected_tree2_2]);
    assert_eq!(true,tst.eval(tree2.as_str()));
    Ok(())
}

#[test]
fn cpm_host_to_image() -> STDRESULT {
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("osb.imd");
    std::fs::write(dir.path().join("GO.SUB"),"PIP B:PROG1.BAS=A:PROG1.BAS\nB:\nREN PROG2.BAS=PROG1.BAS\n")?;
    std::fs::write(dir.path().join("DATA"),&[0xff,0x01,0xe0,0xd5])?;

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("mkdsk")
        .arg("-t").arg("imd").arg("-o").arg("cpm2")
        .arg("-k").arg("5.25in-osb-sssd")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp")
        .arg(dir.path().join("GO.SUB"))
        .arg(dir.path().join("DATA"))
        .arg(dimg_path.clone())
        .assert().success();

    let expected = 
r#"A: GO       SUB : DATA"#;
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("catalog")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success()
        .stdout(predicate::str::contains(expected));

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("get")
        .arg("-d").arg(dimg_path.clone())
        .arg("-t").arg("bin")
        .arg("-f").arg("DATA")
        .assert()
        .success()
        .stdout(predicate::eq(vec![0xff,0x01,0xe0,0xd5]));

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("get")
        .arg("-d").arg(dimg_path.clone())
        .arg("-t").arg("bin")
        .arg("-f").arg("GO.SUB")
        .assert()
        .success()
        .stdout(predicate::str::starts_with("PIP B:PROG1.BAS=A:PROG1.BAS\r\nB:\r\nREN PROG2.BAS=PROG1.BAS\r\n"));

        Ok(())
}

#[test]
fn fat_to_image_subdir() -> STDRESULT {
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("fat.td0");
    let dimg_sub_path = dir.path().join("fat.td0/sub");
    std::fs::write(dir.path().join("GO.BAT"),"COPY B:PROG1.BAS A:PROG1.BAS\nB:\nRENAME PROG1.BAS PROG2.BAS\n")?;
    std::fs::write(dir.path().join("DATA"),&[0xff,0x01,0xe0,0xd5])?;

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("mkdsk")
        .arg("-t").arg("td0").arg("-o").arg("fat")
        .arg("-k").arg("5.25in-ibm-dsdd9")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("mkdir")
        .arg("-f").arg("sub")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp")
        .arg(dir.path().join("GO.BAT"))
        .arg(dir.path().join("DATA"))
        .arg(dimg_sub_path.clone())
        .assert().success();

    let expected = 
r#"DIR      1  
DIR      1  
BAT      1  GO
         1  DATA"#;
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("catalog")
        .arg("-d").arg(dimg_path.clone())
        .arg("-f").arg("sub")
        .arg("--generic")
        .assert()
        .success()
        .stdout(predicate::str::contains(expected));

        Ok(())
}

fn cp_suffix(dir: tempfile::TempDir, dimg_path: PathBuf) -> STDRESULT {
    
    // put some binary in the temp directory with suffix

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("put")
        .arg("-f").arg(dir.path().join("test#060300"))
        .write_stdin(vec![1,2,3,4])
        .assert().success();

    // put the same data interpreted as text (ascii control codes) without suffix

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("put")
        .arg("-f").arg(dir.path().join("text"))
        .write_stdin(vec![1,2,3,4])
        .assert().success();

    // copy the binary and text to the disk image with suffix option

    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp")
        .arg("--suffix")
        .arg(dir.path().join("test#060300"))
        .arg(dir.path().join("text"))
        .arg(dimg_path.clone())
        .assert().success();

    // copy it back to another temp directory and check suffix

    let dir2 = tempfile::tempdir()?;
    cmd = cargo::cargo_bin_cmd!("a2kit");
    cmd.arg("cp")
        .arg("--suffix")
        .arg([dimg_path.clone().to_str().unwrap(),"/TEST"].concat())
        .arg([dimg_path.clone().to_str().unwrap(),"/TEXT"].concat())
        .arg(dir2.path())
        .assert().success();

    assert!(std::fs::exists(dir2.path().join("TEST#060300")).expect("file exists"));
    assert!(std::fs::exists(dir2.path().join("TEXT.txt")).expect("file exists"));

    Ok(())
}

#[test]
fn cp_suffix_dos() -> STDRESULT {
    
    // make a disk image in the temp directory

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("dos33.do");
    cmd.arg("mkdsk")
        .arg("-v").arg("254").arg("-t").arg("do").arg("-o").arg("dos33")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    cp_suffix(dir, dimg_path)?;

    Ok(())
}

#[test]
fn cp_suffix_prodos() -> STDRESULT {
    
    // make a disk image in the temp directory

    let mut cmd = cargo::cargo_bin_cmd!("a2kit");
    let dir = tempfile::tempdir()?;
    let dimg_path = dir.path().join("prodos.do");
    cmd.arg("mkdsk")
        .arg("-v").arg("NEW.DISK").arg("-t").arg("do").arg("-o").arg("prodos")
        .arg("-d").arg(dimg_path.clone())
        .assert()
        .success();

    cp_suffix(dir, dimg_path)?;

    Ok(())
}