kibi-cursor 2.10.0 → 2.11.0

package/skills/kibi-usage/resources/prolog-proofs.md

@@ -0,0 +1,207 @@
+# SWI-Prolog Code Proofs
+
+Kibi reads code models from SWI-Prolog files (`.pl`, `.plt`) with the
+SWI-Prolog it runs on (KIBI_SWIPL, the bundled runtime, then `swipl` on
+PATH). It loads the file a symbol names (a module, or a plain file into
+`user`) and reads a predicate named by its indicator, the symbol's title
+(`operator/2`, `lists:append/3`, `greeting//1`) or `export`.
+
+- A domain (`exhaustive`, `domains`, `value_source` with `measure: count`)
+  is the distinct solutions of one argument. A one-argument predicate needs
+  nothing more; for more arguments set `arg` (1-based) to the one that names
+  each member: `domain_source: {symbol_id: SYM-operator, arg: 1}` lists every
+  `Name` of `operator(Name, Description)`. A solution that leaves that
+  argument unbound refuses the read.
+- A value (`value_source`) is the single number a constant holds:
+  `hard_limit_seconds(10).` Zero or several solutions refuse the read.
+- A `rule` predicate is called once per row of its argument domains; success
+  is true, failure false, an exception an error row (which rejects).
+- A `state_machine` transition table is a `Name/2` (from, to) or `Name/3`
+  (from, event, to) fact table: every solution is an edge. With `domains:
+  {state, event}` a `Name/3` next-state predicate is called on every state
+  and event. `initial_source` names an `initial/1`-style fact.
+- A `regex` reads an atom or string constant as a `type: string` pattern;
+  Kibi decides string facts on it. Patterns for `library(pcre)` are not read.
+
+Loading a module runs its directives, the same trust a JavaScript import
+gives. The proof file must name the predicate and load its file
+(`use_module`, `ensure_loaded`, `consult`, a `:- [..]` load list, or
+`library(X)` for a pack's `prolog/X.pl`), or be the plunit `.plt` file
+beside it; otherwise Kibi treats the domain as hand-listed. `arg` on a
+TypeScript, JavaScript or Python export is refused, and so is `field` on a
+Prolog predicate.
+
+## Writing the certificate
+
+A Prolog test writes the `kibi.code-certificate.v1` JSON into the directory
+`kibi prove` sets in `KIBI_PROOF_CERTIFICATES`. Copy this module into the
+project's test directory (for example `test/kibi_certificate.pl`) and call it
+from the proof. Read members from the code with `findall/3` over the domain
+predicate; never list them by hand.
+
+```prolog
+:- module(kibi_certificate,
+          [ kibi_exhaustive_certificate/5,  % +TestId, +SymbolId, +Members, :Check, -Certificate
+            kibi_rule_certificate/4,        % +TestId, +Domains, +Predicates, -Certificate
+            kibi_machine_certificate/5,     % +TestId, +SymbolId, +Edges, +Initial, -Certificate
+            kibi_pattern_certificate/4,     % +TestId, +SymbolId, +Text, -Certificate
+            kibi_write_certificate/1        % +Certificate
+          ]).
+:- use_module(library(http/json)).
+:- use_module(library(apply)).
+:- use_module(library(lists)).
+
+:- meta_predicate
+    kibi_exhaustive_certificate(+, +, +, 1, -).
+
+% Members as Kibi reads them: atoms and strings as text, numbers as written,
+% other terms quoted.
+kibi_text(Value, Text) :- string(Value), !, Text = Value.
+kibi_text(Value, Text) :- atom(Value), !, atom_string(Value, Text).
+kibi_text(Value, Text) :- number(Value), !, number_string(Value, Text).
+kibi_text(Value, Text) :- format(string(Text), "~q", [Value]).
+
+%!  kibi_exhaustive_certificate(+TestId, +SymbolId, +Members, :Check, -Certificate)
+%
+%   Run Check on every member of the domain and record each outcome. Read
+%   Members from the code (findall over the domain predicate), never list
+%   them by hand: Kibi re-reads the predicate and rejects a different set.
+kibi_exhaustive_certificate(TestId, SymbolId, Members, Check, Certificate) :-
+    maplist(kibi_text, Members, Texts),
+    maplist(exhaustive_result(Check), Members, Texts, Results),
+    Certificate = _{version: "kibi.code-certificate.v1", kind: "exhaustive",
+                    test_id: TestId,
+                    domain: _{symbol_id: SymbolId, members: Texts},
+                    results: Results}.
+
+exhaustive_result(Check, Member, Text, Result) :-
+    catch(( call(Check, Member)
+          -> Result = _{member: Text, outcome: "passed"}
+          ;  Result = _{member: Text, outcome: "failed", message: "the check failed"}
+          ),
+          Error,
+          ( message_to_text(Error, Message),
+            Result = _{member: Text, outcome: "failed", message: Message} )).
+
+%!  kibi_rule_certificate(+TestId, +Domains, +Predicates, -Certificate)
+%
+%   Domains is a list of domain(Type, SymbolId, Members); Predicates a list
+%   of predicate(Name, SymbolId, ArgTypes, Goal), where Goal is called with
+%   one argument per type appended and decides the row by success or
+%   failure.
+kibi_rule_certificate(TestId, Domains, Predicates, Certificate) :-
+    findall(Type-_{symbol_id: SymbolId, members: Texts},
+            ( member(domain(Type, SymbolId, Members), Domains), maplist(kibi_text, Members, Texts) ),
+            DomainPairs),
+    dict_pairs(DomainDict, _, DomainPairs),
+    findall(Name-_{symbol_id: SymbolId, arg_types: ArgTypes, rows: Rows},
+            ( member(predicate(Name, SymbolId, ArgTypes, Goal), Predicates),
+              maplist(domain_members(Domains), ArgTypes, Lists),
+              findall(Row, (maplist(member, Tuple, Lists), rule_row(Goal, Tuple, Row)), Rows)
+            ),
+            PredicatePairs),
+    dict_pairs(PredicateDict, _, PredicatePairs),
+    Certificate = _{version: "kibi.code-certificate.v1", kind: "rule",
+                    test_id: TestId, domains: DomainDict, predicates: PredicateDict}.
+
+domain_members(Domains, Type, Members) :-
+    memberchk(domain(Type, _, Members), Domains).
+
+rule_row(Goal, Tuple, Row) :-
+    maplist(kibi_text, Tuple, Args),
+    Call =.. [call, Goal|Tuple],
+    catch(( once(Call) -> Row = _{args: Args, value: true} ; Row = _{args: Args, value: false} ),
+          Error,
+          ( message_to_text(Error, Message), Row = _{args: Args, error: Message} )).
+
+%!  kibi_machine_certificate(+TestId, +SymbolId, +Edges, +Initial, -Certificate)
+%
+%   Edges is the list of From-To pairs of the transition table (findall over
+%   it); Initial is the list of initial states, or [] when the contract names
+%   no initial_source.
+kibi_machine_certificate(TestId, SymbolId, Edges, Initial, Certificate) :-
+    findall([F, T], (member(From-To, Edges), kibi_text(From, F), kibi_text(To, T)), Pairs0),
+    sort(Pairs0, Pairs),
+    findall(S, (member([A, B], Pairs), member(S, [A, B])), Ends),
+    sort(Ends, States),
+    Machine0 = _{symbol_id: SymbolId, states: States, transitions: Pairs},
+    (   Initial == []
+    ->  Machine = Machine0
+    ;   maplist(kibi_text, Initial, InitialTexts0),
+        sort(InitialTexts0, InitialTexts),
+        Machine = Machine0.put(initial, InitialTexts)
+    ),
+    Certificate = _{version: "kibi.code-certificate.v1", kind: "state_machine",
+                    test_id: TestId, machine: Machine}.
+
+%!  kibi_pattern_certificate(+TestId, +SymbolId, +Text, -Certificate)
+%
+%   The string or atom constant a string claim is about.
+kibi_pattern_certificate(TestId, SymbolId, Value, Certificate) :-
+    kibi_text(Value, Text),
+    Certificate = _{version: "kibi.code-certificate.v1", kind: "regex", test_id: TestId,
+                    pattern: _{symbol_id: SymbolId, type: "string", value: Text}}.
+
+%!  kibi_write_certificate(+Certificate)
+%
+%   Leave the certificate where kibi prove reads it (the directory in
+%   KIBI_PROOF_CERTIFICATES). Does nothing outside a kibi prove run.
+kibi_write_certificate(Certificate) :-
+    (   getenv('KIBI_PROOF_CERTIFICATES', Directory), Directory \== ''
+    ->  make_directory_path(Directory),
+        format(atom(Name), "~w.json", [Certificate.test_id]),
+        directory_file_path(Directory, Name, File),
+        setup_call_cleanup(open(File, write, Out, [encoding(utf8)]),
+                           json_write_dict(Out, Certificate, [width(0)]),
+                           close(Out))
+    ;   true
+    ).
+
+message_to_text(Error, Text) :-
+    catch(message_to_codes(Error, Text), _, fail), !.
+message_to_text(Error, Text) :- format(string(Text), "~q", [Error]).
+
+message_to_codes(Error, Text) :-
+    '$messages':translate_message(Error, Lines, []),
+    with_output_to(string(Raw), print_message_lines(current_output, '', Lines)),
+    split_string(Raw, "", "\n ", [Text]).
+```
+
+A proof that the operators are exactly the claimed set:
+
+```prolog
+:- use_module('../prolog/operators').
+:- use_module(kibi_certificate).
+:- initialization(main, main).
+
+main :-
+    findall(Name, operator(Name, _), Names0),
+    list_to_set(Names0, Names),
+    kibi_exhaustive_certificate('TEST-operator-set', 'SYM-operator', Names,
+                                [Name]>>operator(Name, _), Certificate),
+    kibi_write_certificate(Certificate).
+```
+
+Its contract: `kind: exhaustive`, `domain_source: {symbol_id: SYM-operator,
+arg: 1}`, `proves: [CLAIM-...]`. A rule proof passes
+`[domain(status, 'SYM-status', Statuses)]` and
+`[predicate(detected, 'SYM-detected', [status], detected)]`; its contract
+names `predicate_source: {detected: {symbol_id: SYM-detected}}` and
+`domains: {status: {symbol_id: SYM-status}}`.
+
+## Source proofs over Prolog code
+
+A `source` proof needs no certificate: Kibi reads the Prolog files itself,
+term by term, and never runs them. Use the `references` reader on `.pl` and
+`.plt` files for what modules load (`extract: imports`, members as written:
+`library(lists)`, `helpers`), call (`calls`, `Name/Arity` or
+`Module:Name/Arity`), read from the environment (`env`, `getenv/2`), pass as
+a first argument (`string_args` with `callee`) and throw (`thrown`: the error
+of `error(type_error(...), _)` is `type_error`). Use the `prolog` reader for
+facts: `{reader: prolog, file: pack.pl, functor: requires/1}` lists a pack's
+requirements, and `arg` picks the argument of a fact with several. A goal or
+closure held in a variable (`call(Goal)`, `maplist(G, L)`), a goal with a
+variable module, a clause asserted from a variable and `:- if(...)` fail the
+read with their place: name the predicate instead. The claim cannot be
+decided for a file the read refuses; never drop a file the claim is about
+from `files`.

package/skills/kibi-usage/resources/proof.md

@@ -262,11 +262,15 @@ left:
   each list item, such as the `run` of each workflow step), `glob` (`pattern`, `capture`),
   `openapi` (`file`, `select: operations|unsecured_operations|...`),
   `references` (`files`, `extract: env|imports|calls|string_args|thrown|
-  property`), `schema` (`format: drizzle|prisma|sql`, `select:
+  property`; TypeScript, JavaScript, Python and SWI-Prolog files, and Go,
+  Java, C# and Rust files through `kibi-plugin-treesitter`), `schema` (`format: drizzle|prisma|sql`, `select:
   tables|columns|required_columns|nullable_columns|foreign_keys`), `routes`
   (Hono or Express app export, `path_prefix`, `names_from`, `select:
   routes|middleware`) or `validator` (zod, valibot or pydantic, `select:
-  fields|required_fields|optional_fields`). A member Kibi cannot read
+  fields|required_fields|optional_fields`) or `prolog` (`file`, `functor:
+  requires/1`, `arg`: one argument of each fact, such as a pack's
+  requirements in `pack.pl`). Prolog files are read term by term and never
+  run; see `resources/prolog-proofs.md`. A member Kibi cannot read
   statically (a computed env name, a dynamic import, an env object handed
   to a variable) fails the read with its location, and so does an empty
   read (a glob matching no file, migrations with no `CREATE TABLE`), so a
@@ -288,6 +292,40 @@ left:
   The builders need kibi-cli 2.33.0 or newer in the project. The env
   extractor reads `process.env`, `import.meta.env`, `Bun.env`,
   `Deno.env.get`, `os.environ` and `os.getenv`, through casts.
+- `references` over Go, Java, C# or Rust needs `kibi-plugin-treesitter` and
+  the language's grammar pack (`kibi-lang-go`, `kibi-lang-java`,
+  `kibi-lang-csharp`, `kibi-lang-rust`) in `devDependencies`, with the
+  plugin activated for proofs:
+  `"kibi.reference-extractor.v1": { "mode": "augment" }` in its
+  `kibi.plugins` entry (next to `"kibi.symbol-extractor.v2"`). A project
+  with no `package.json` creates one that only holds this list. Without it
+  the read is refused with what to install, so ask the operator before
+  installing; `kibi doctor` names what the project needs. Members are
+  written as the code names them (`os.Getenv`, `System.out.println`,
+  `Console.WriteLine`, `std::env::var`, Go import paths, `java.util.*`,
+  `std::io::Write`); a method on an expression Kibi cannot name is
+  `*.name`. Reflection, a name computed at run time, the whole
+  environment, C# `dynamic` and `#if`, Rust `#[cfg(...)]` items other than
+  `#[cfg(test)]`, and any macro for Rust `calls` and `thrown` fail the
+  read with their place: the claim cannot be decided for that file, so
+  model a claim the code can show (Rust `calls` over a file with
+  `println!` is always refused). Never drop a file the claim is about
+  from `files`: the read decides a claim only for the files it covers,
+  and a proof is rejected when a symbol the test covers or that
+  implements the claim's requirement lies outside them.
+- Reference members match by name segments (`.`, `/`, `::`). `excludes`
+  fails on anything that is or may be an excluded item: `java.sql`
+  excludes `java.sql.Connection`, `github.com/labstack/echo/v4` excludes
+  `.../echo/v4/middleware`, a trailing `*` is a prefix (`java.sql.*`), a
+  wildcard import or a shorter name (`File.delete`) may be the item, and
+  `*.delete` (a call on a receiver Kibi cannot name) may be
+  `java.io.File.delete`, so the claim is refused naming it. `includes` and
+  `subset_of` count only members that certainly are an item (the item, a
+  member under `X.*`, or `a.b.m` for `*.m`); `eq` compares spellings.
+- For a claim about what the code reads from the environment use
+  `extract: env`: `string_args` on a getter (`os.Getenv`, `env::var`,
+  `System.getenv`, `getenv/2`, ...) sees only that getter, so Kibi refuses
+  it for `eq`, `subset_of` and `excludes`.
 
 `arithmetic` and `smt` from `constraint_source` alone prove that the
 knowledge base's facts entail the claim, not that code follows the facts:
@@ -318,7 +356,10 @@ read for a test that wants to assert on it), fail the test when it records a fai
 (`failedMembers`, `failedCalls`), and call `writeCodeCertificate`; it writes to the
 directory `kibi prove` sets in `KIBI_PROOF_CERTIFICATES` and does nothing
 elsewhere. A Python test writes the same `kibi.code-certificate.v1` JSON
-to that directory itself. Wire the KB: the proof file symbol is
+to that directory itself. Kibi also reads SWI-Prolog domains, constants,
+rule predicates, transition tables and string constants (`arg` picks a
+predicate's argument); `resources/prolog-proofs.md` has the rules and a
+certificate module to copy. Wire the KB: the proof file symbol is
 `executable_for` the test and named in `required_proofs`; the domain symbol
 (and every symbol a rule, machine or pattern contract names) `implements`
 the requirement and is `covered_by` the test; the test