Softanza
StartFrançais
Softanza
StartFrançais
Reference · stzRuleReport

IsSound()

the verdict + rendering ----------------------------------------- the CI gate: TRUE when no ERROR-severity finding fired anywhere. Warnings advise (same convention as stzGraphRuleSet / stzSecurityPosture).

Basic examples (2)

Softanza
oRep = new stzRuleReport("sev")
oSG = new stzSecurityGraph("s")
oSG.AddSecret("inline")
oSG.AddSite("prod")
oSG.References("prod", "inline")     # unstored-secret -> WARNING only
oRep.Collect(oSG)
# there is a warning
? len(oRep.Warnings()) >= 1
# ...no error
? len(oRep.Errors())
# ...so the gate is SOUND (warnings advise)
? oRep.IsSound()
Output
1
0
1

run on 2026-10-02 04:22 inside the library at commit 0e72e2e2c; taken from rulereport_narrated.ring(opens in a new tab)

Softanza
oOrg = new stzOrgChart("acme")
oOrg.AddExecutivePosition("ceo")
oOrg.AddStaffPosition("rogue")
oOrg.ReportsTo("rogue", "rogue")
oRep = new stzRuleReport("acme")
oRep.Collect(oOrg)             # the org chart checks itself into the gate
# the gate collected orgchart findings
? len(oRep.FindingsOfSubject("orgchart")) >= 1
# ...tagged with :subject = orgchart
? oRep.Findings()[1][:subject]
# ...and the gate is unsound
? oRep.IsSound()
Output
1
orgchart
0

run on 2026-10-02 04:22 inside the library at commit 0e72e2e2c; taken from orgrule_narrated.ring(opens in a new tab)

Scope (2)

Softanza
oRep = new stzRuleReport("clean")
oAG = new stzAgentGraph("ok")
oAG.AddLLMActor("writer")
oAG.AddGuardian("gate")
oAG.AddEffect("send")
oAG.AddTraceSink("audit")
oAG.Proposes("writer", "gate")
oAG.Guards("gate", "send")
oAG.Feeds("gate", "send")
oAG.Traces("send", "audit")
oRep.Collect(oAG)
oCG = new stzRingCodeGraph("")
oCG.ScanSource("class Bag" + nl + "def Count()" + nl + "	return 1" + nl, "s")
oRep.Collect(oCG)
# no findings
? oRep.NumberOfFindings()
# ...the gate is sound
? oRep.IsSound()
Output
0
1

run on 2026-10-02 04:22 inside the library at commit 0e72e2e2c; taken from rulereport_narrated.ring(opens in a new tab)

Softanza
oAG = new stzAgentGraph("bad")
oAG.AddLLMActor("writer")
oAG.AddEffect("send")
oAG.Proposes("writer", "send")
aLegacyAgent = StzCheckAgentGraph(oAG.GraphQ())     # [ :invariant, :node, ... ]
aLegacyCode  = StzCheckCode("class Bag" + nl + "def Len()" + nl + "	return 1" + nl)  # [ :line, ... ]
oRep = new stzRuleReport("mixed")
oRep.IngestLegacy(aLegacyAgent, "agentic")
oRep.IngestLegacy(aLegacyCode, "code")
# legacy findings are normalized into the unified shape
? HasKey(oRep.Findings()[1], :rule) and HasKey(oRep.Findings()[1], :subject) and
	     HasKey(oRep.Findings()[1], :where)
# ...the invariant name became :rule
? len(oRep.Findings()[1][:rule]) > 0
# ...tagged with the given subject
? len(oRep.FindingsOfSubject("agentic")) >= 1
# ...and the code line landed in :where
? len(oRep.FindingsOfSubject("code")) >= 1
# the one gate spans legacy sources too
? oRep.IsSound()
Output
1
1
1
1
0

run on 2026-10-02 04:22 inside the library at commit 0e72e2e2c; taken from rulereport_narrated.ring(opens in a new tab)

The extensions of this method

Each extension, and whether it exists for this method; an extension that exists combines with the others (FindSTCS).

Extension
Exists
What it adds · The names
Q
no
does what the method does, then returns the object, so the call can be chained
QQ
no
chains on the next, more specific type of object (the Q ladder)
QQQ
no
chains on the most specific type of object (the Q ladder)
QRT
no
returns the result as an object of the requested type
CS
no
takes a case-sensitivity flag
ST
no
takes the position to start from (StartingAt)
IB
no
takes bounds that are included (IncludingBounds)
XT
no
the extended form: more parameters than the base method
XTT
no
yet another extension: a further extended form, after XT
Z
no
includes the position in what it returns
ZZ
no
returns positions as sections, [start, end]
W
no
selects by a condition
WF
no
selects by a condition, with the expressive keywords (@NextItem, @PreviousItem...)
D
no
takes a direction, forward or backward (Directional)
F
no
takes a function (the condition or the update is given as a function); the forms document also uses F for the future form, which defers the action
Many
no
works on a collection of items instead of one (the plural form)
Except
no
takes exceptions, what to leave out (the exceptional form)
U
no
returns the result without duplication

Every example is a test file of the library, run inside the library for this page; only those whose output kept every promise their file wrote are shown.

See also