HTTP API: pack

Proč sledovaný soubor není v balíčku. Každý důvod kromě derived a excluded je konečný: žádné include profilu nepřipustí zpět odkaz, gitlink, artefakt ani binárku.

use majordomus_cli::pack::DropReason;
assert_eq!(DropReason::Binary.as_str(), "binary");
let json = serde_json::to_string(&DropReason::Artifact).unwrap();
assert_eq!(json, "\"artifact\"");

Jeden vynechaný soubor, který report jmenuje. Odvozené soubory se počítají, nevypisují: jsou funkcí souborů, které v balíku jsou.

Níže uvedené příklady plánují repozitář obsahující main.rs a logo.png, jejíž obsah je binární, s distribucí, jejíž profil chat má limity a profil bare žádné.

use majordomus_cli::pack::{plan, DropReason, DroppedFile};
#### use std::process::Command;
#### let dir = tempfile::tempdir().unwrap();
#### let (root, share) = (dir.path().join("repo"), dir.path().join("share"));
#### std::fs::create_dir_all(&root).unwrap();
#### std::fs::create_dir_all(&share).unwrap();
#### std::fs::write(share.join("archive.yaml"), "default: chat\nprofiles:\n  - id: chat\n    binary: drop\n    artifacts: drop\n    shards:\n      max_count: 5\n      max_tokens: 4000\n  - id: bare\n    binary: drop\n").unwrap();
#### let git = |a: &[&str]| assert!(Command::new("git").arg("-C").arg(&root)
####     .args(["-c", "user.email=t@example.com", "-c", "user.name=t"]).args(a)
####     .status().unwrap().success());
#### git(&["init", "-q"]);
#### std::fs::write(root.join("main.rs"), "fn main() {}\n").unwrap();
#### std::fs::write(root.join("logo.png"), b"\x89PNG\0\x01").unwrap();
#### git(&["add", "-A"]);
#### git(&["commit", "-q", "-m", "one"]);
let dropped = plan(&root, &share, None).plan.dropped_files;
let want = DroppedFile { path: "logo.png".into(), reason: DropReason::Binary };
assert_eq!(dropped, [want]);

Důvod, proč balík nelze sestavit podle plánu, nebo proč zapsaný balík neodpovídá svému manifestu: stabilní kód, cesta, je-li nějaká, a náprava.

Níže uvedené příklady plánují repozitář obsahující main.rs a logo.png, jejíž obsah je binární, s distribucí, jejíž profil chat má limity a profil bare žádné.

use majordomus_cli::pack::{plan, PackFinding};
#### use std::process::Command;
#### let dir = tempfile::tempdir().unwrap();
#### let (root, share) = (dir.path().join("repo"), dir.path().join("share"));
#### std::fs::create_dir_all(&root).unwrap();
#### std::fs::create_dir_all(&share).unwrap();
#### std::fs::write(share.join("archive.yaml"), "default: chat\nprofiles:\n  - id: chat\n    binary: drop\n    artifacts: drop\n    shards:\n      max_count: 5\n      max_tokens: 4000\n  - id: bare\n    binary: drop\n").unwrap();
#### let git = |a: &[&str]| assert!(Command::new("git").arg("-C").arg(&root)
####     .args(["-c", "user.email=t@example.com", "-c", "user.name=t"]).args(a)
####     .status().unwrap().success());
#### git(&["init", "-q"]);
#### std::fs::write(root.join("main.rs"), "fn main() {}\n").unwrap();
#### std::fs::write(root.join("logo.png"), b"\x89PNG\0\x01").unwrap();
#### git(&["add", "-A"]);
#### git(&["commit", "-q", "-m", "one"]);
let findings: Vec<PackFinding> = plan(&root, &share, Some("bare")).plan.findings;
assert_eq!(findings[0].code, "pack.no_limits");
assert!(findings[0].path.is_none() && !findings[0].remedy.is_empty());

Plán jednoho balíčku: co nese, co vynechává a proč, jak je rozřezán na shardy a zda může být sestaven.

Níže uvedené příklady plánují repozitář obsahující main.rs a logo.png, jejíž obsah je binární, s distribucí, jejíž profil chat má limity a profil bare žádné.

use majordomus_cli::pack::{plan, PackPlan};
#### use std::process::Command;
#### let dir = tempfile::tempdir().unwrap();
#### let (root, share) = (dir.path().join("repo"), dir.path().join("share"));
#### std::fs::create_dir_all(&root).unwrap();
#### std::fs::create_dir_all(&share).unwrap();
#### std::fs::write(share.join("archive.yaml"), "default: chat\nprofiles:\n  - id: chat\n    binary: drop\n    artifacts: drop\n    shards:\n      max_count: 5\n      max_tokens: 4000\n  - id: bare\n    binary: drop\n").unwrap();
#### let git = |a: &[&str]| assert!(Command::new("git").arg("-C").arg(&root)
####     .args(["-c", "user.email=t@example.com", "-c", "user.name=t"]).args(a)
####     .status().unwrap().success());
#### git(&["init", "-q"]);
#### std::fs::write(root.join("main.rs"), "fn main() {}\n").unwrap();
#### std::fs::write(root.join("logo.png"), b"\x89PNG\0\x01").unwrap();
#### git(&["add", "-A"]);
#### git(&["commit", "-q", "-m", "one"]);
let p: PackPlan = plan(&root, &share, None).plan;
assert!(p.measured && p.passes && p.index_matches_head);
assert_eq!((p.tracked, p.selected), (2, 1));
assert_eq!(p.dropped["binary"], 1);
// an unknown profile is not measured, and not measured is never a pass
let p: PackPlan = plan(&root, &share, Some("nope")).plan;
assert!(!p.measured && !p.passes);

Verdikt o zapsaném balíčku: zda šel přečíst, co jmenuje jeho manifest, kolik souborů a zdrojů obsahuje a každé zjištění proti němu.

Příklady níže sestavují balíček repozitáře obsahujícího main.rs.

use majordomus_cli::pack::{build, plan, verify, PackVerdict, Profiles};
#### use std::process::Command;
#### let dir = tempfile::tempdir().unwrap();
#### let (root, share) = (dir.path().join("repo"), dir.path().join("share"));
#### std::fs::create_dir_all(&root).unwrap();
#### std::fs::create_dir_all(&share).unwrap();
#### std::fs::write(share.join("archive.yaml"), "default: chat\nprofiles:\n  - id: chat\n    binary: drop\n    artifacts: drop\n    shards:\n      max_count: 5\n      max_tokens: 4000\n").unwrap();
#### let git = |a: &[&str]| assert!(Command::new("git").arg("-C").arg(&root)
####     .args(["-c", "user.email=t@example.com", "-c", "user.name=t"]).args(a)
####     .status().unwrap().success());
#### git(&["init", "-q"]);
#### std::fs::write(root.join("main.rs"), "fn main() {}\n").unwrap();
#### git(&["add", "-A"]);
#### git(&["commit", "-q", "-m", "one"]);
let profiles = Profiles::load(&share, &root).unwrap();
let out = dir.path().join("pack");
let v: PackVerdict = build(&plan(&root, &share, None), &root, &out).unwrap();
assert_eq!((v.files, v.sources), (2, 1), "the index and one shard, carrying one file");
assert_eq!(v.profile.as_deref(), Some("chat"));
// a directory with no manifest is not measured, which is not a pass
let v: PackVerdict = verify(dir.path(), &profiles, &root);
assert!(!v.measured && !v.passes);

Limity shardů profilu: vlastní limity čtenáře na to, co dokáže indexovat, počet souborů projektu a tokeny, které smí obsahovat jeden jeho soubor.

use majordomus_cli::pack::{Profiles, ShardLimits};
let p = Profiles::parse(
    "default: a\nprofiles:\n  - id: a\n    shards:\n      max_count: 20\n      max_tokens: 900\n",
)
.unwrap();
let want = ShardLimits { max_count: 20, max_tokens: 900 };
assert_eq!(p.profile(None).unwrap().shards, Some(want));

Jeden plánovaný shard: soubor Markdown packu, cesty, které nese od první do poslední, a kolik váží v bajtech a v tokenech.

Níže uvedené příklady plánují repozitář obsahující main.rs a logo.png, jejíž obsah je binární, s distribucí, jejíž profil chat má limity a profil bare žádné.

use majordomus_cli::pack::{plan, ShardPlan};
#### use std::process::Command;
#### let dir = tempfile::tempdir().unwrap();
#### let (root, share) = (dir.path().join("repo"), dir.path().join("share"));
#### std::fs::create_dir_all(&root).unwrap();
#### std::fs::create_dir_all(&share).unwrap();
#### std::fs::write(share.join("archive.yaml"), "default: chat\nprofiles:\n  - id: chat\n    binary: drop\n    artifacts: drop\n    shards:\n      max_count: 5\n      max_tokens: 4000\n  - id: bare\n    binary: drop\n").unwrap();
#### let git = |a: &[&str]| assert!(Command::new("git").arg("-C").arg(&root)
####     .args(["-c", "user.email=t@example.com", "-c", "user.name=t"]).args(a)
####     .status().unwrap().success());
#### git(&["init", "-q"]);
#### std::fs::write(root.join("main.rs"), "fn main() {}\n").unwrap();
#### std::fs::write(root.join("logo.png"), b"\x89PNG\0\x01").unwrap();
#### git(&["add", "-A"]);
#### git(&["commit", "-q", "-m", "one"]);
let planned = plan(&root, &share, None);
let first: &ShardPlan = &planned.plan.shards[0];
assert_eq!((first.files, first.first.as_str(), first.last.as_str()), (1, "main.rs", "main.rs"));
assert!(first.file.ends_with(".md") && first.tokens > 0);