Package io.github.flink.gcp.connector.testutils

Class OptionDescriptionAssertions

java.lang.Object

io.github.flink.gcp.connector.testutils.OptionDescriptionAssertions

@Internal
public final class OptionDescriptionAssertions
extends Object

Assertions shared by the Table API option-set tests.

Method Summary

Modifier and Type	Method	Description
static void	assertNoDefaultRestatement(String optionKey, String formattedDescription, String documentationHome)	Rejects the default-restatement forms that the cross-connector sweep found.

Methods inherited from class java.lang.Object

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

Method Details

assertNoDefaultRestatement

public static void assertNoDefaultRestatement(String optionKey,
 String formattedDescription,
 String documentationHome)

Rejects the default-restatement forms that the cross-connector sweep found.

Pub/Sub supplied the first two phrases through #778/#838: Off by default: and two Defaults to twice the effective flow-control ... limit descriptions accumulated while every existing check stayed green. #1001 added two absent-value forms, and #1045 found the remaining eight in the sibling connectors. The list is a regression guard over those recorded forms, not a semantic parser for arbitrary prose. Keeping it here makes the five connector guards use one list while leaving their different option-discovery rules local.

The caller formats the joined Flink description before this assertion. That keeps string-literal boundaries from hiding a phrase and keeps Flink's unannotated HtmlFormatter out of this module's API-tier-audited main sources.

Parameters:

optionKey - the option whose description is checked

formattedDescription - the joined and formatted option description

documentationHome - where the option's default is documented