Class HelpBundleAssertions

java.lang.Object

com.kingsrook.qqq.backend.core.testing.HelpBundleAssertions

public class HelpBundleAssertions
extends Object

Framework-independent help coverage gate for core, qbits and host applications.

Method Summary

Modifier and Type	Method	Description
void	assertComplete()	Fail once with the complete list, so authors can fix every issue together.
HelpBundleAssertions	bundles(String... resources)	Load resources independently of the instance's registered bundles.
HelpBundleAssertions	excluding(String... keys)	Exempt explicit keys from required coverage.
HelpBundleAssertions	excludingFields(Predicate<QFieldMetaData> predicate)	Exempt application-specific trivial fields.
static HelpBundleAssertions	forInstance(QInstance instance)	Entry point, with no dependency on JUnit.
static boolean	matches(String key, String target)	Match the supported process suffix wildcard without treating keys as regex.
HelpBundleAssertions	owning(Predicate<HelpTarget> owning)	Select targets using their kind, key, name, table or owner.
List<String>	report()	Return all missing coverage and invalid entries, suitable for tooling.
static boolean	resolves(QInstance instance, String key)	Slots are extensible; fields, sections and steps must exist in metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

forInstance

public static HelpBundleAssertions forInstance(QInstance instance)

Entry point, with no dependency on JUnit.

bundles

public HelpBundleAssertions bundles(String... resources)

Load resources independently of the instance's registered bundles.

owning

public HelpBundleAssertions owning(Predicate<HelpTarget> owning)

Select targets using their kind, key, name, table or owner.

excluding

public HelpBundleAssertions excluding(String... keys)

Exempt explicit keys from required coverage.

excludingFields

public HelpBundleAssertions excludingFields(Predicate<QFieldMetaData> predicate)

Exempt application-specific trivial fields.

report

public List<String> report()

Return all missing coverage and invalid entries, suitable for tooling.

assertComplete

public void assertComplete()

Fail once with the complete list, so authors can fix every issue together.

matches

public static boolean matches(String key,
 String target)

Match the supported process suffix wildcard without treating keys as regex.

resolves

public static boolean resolves(QInstance instance,
 String key)

Slots are extensible; fields, sections and steps must exist in metadata.