fix: replace '<>' with quotes (not html encoded in GitLab) (6e93a154) · Commits · to be continuous... / tools / tbc-check

tbc_check/checker.py

+18 −18

Original line number	Diff line number	Diff line
		@@ -529,7 +529,7 @@ def _check_var(
		if tbc_var.default == "":
		yield Issue(
		Check.var_empty_default_must_be_omitted,
		f"Variable <{tbc_var.name}>: empty default shall be omitted in Kicker",
		f"Variable '{tbc_var.name}': empty default shall be omitted in Kicker",
		tbc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -545,7 +545,7 @@ def _check_var(
		if img_parts[0].find(".") < 0:
		yield Issue(
		Check.container_image_must_use_explicit_registry,
		f"Variable <{tbc_var.name}>: container images must explicitly specify the registry",
		f"Variable '{tbc_var.name}': container images must explicitly specify the registry",
		tbc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -555,7 +555,7 @@ def _check_var(
		if tag != "latest":
		yield Issue(
		Check.container_image_should_use_latest_tag,
		f"Variable <{tbc_var.name}/{expected_input_name}>: container images should use 'latest' tag by default ('{tag}' found)",
		f"Variable '{tbc_var.name}/{expected_input_name}': container images should use 'latest' tag by default ('{tag}' found)",
		tbc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -566,7 +566,7 @@ def _check_var(
		if doc_var is None:
		yield Issue(
		Check.var_should_be_documented,
		f"Variable <{tbc_var.name}>: not documented in README",
		f"Variable '{tbc_var.name}': not documented in README",
		FilePos(readme_path),
		f"/var:{tbc_var.name}",
		)
		@@ -575,7 +575,7 @@ def _check_var(
		if doc_var.default(expected_gl_input.type) != expected_gl_input.default:
		yield Issue(
		Check.var_default_value_should_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: README default doesn't match Kicker's",
		f"Variable '{tbc_var.name}/{expected_input_name}': README default doesn't match Kicker's",
		doc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -583,21 +583,21 @@ def _check_var(
		if doc_var.lock and not tbc_var.secret:
		yield Issue(
		Check.var_non_secret_must_not_show_lock,
		f"Variable <{tbc_var.name}>: is not declared as a secret but has a lock in README",
		f"Variable '{tbc_var.name}': is not declared as a secret but has a lock in README",
		doc_var.pos,
		f"/var:{tbc_var.name}",
		)
		elif not doc_var.lock and tbc_var.secret:
		yield Issue(
		Check.var_secret_must_show_lock,
		f"Variable <{tbc_var.name}>: is declared as a secret but has no lock in README",
		f"Variable '{tbc_var.name}': is declared as a secret but has no lock in README",
		doc_var.pos,
		f"/var:{tbc_var.name}",
		)
		elif not has_no_input and expected_input_name != doc_var.input_name:
		yield Issue(
		Check.var_input_name_should_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: has wrong input declared in README ({doc_var.input_name})",
		f"Variable '{tbc_var.name}/{expected_input_name}': has wrong input declared in README ({doc_var.input_name})",
		doc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -612,7 +612,7 @@ def _check_var(
		if declared_input:
		yield Issue(
		Check.secret_should_not_be_declared,
		f"Variable <{tbc_var.name}> is a secret: must not be declared",
		f"Variable '{tbc_var.name}> is a secret: must not be declared",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -627,7 +627,7 @@ def _check_var(
		if tbc_var.type != orig_var.type:
		yield Issue(
		Check.overridden_var_must_keep_type,
		f"Variable <{tbc_var.name}> is an override: type doesn't match original ({orig_var.type})",
		f"Variable '{tbc_var.name}> is an override: type doesn't match original ({orig_var.type})",
		tbc_var.pos,
		f"/var:{tbc_var.name}",
		)
		@@ -644,7 +644,7 @@ def _check_var(
		if declared_input:
		yield Issue(
		Check.global_var_must_not_be_declared_as_input,
		f"Variable <{tbc_var.name}> is global TBC: must not be declared",
		f"Variable '{tbc_var.name}> is global TBC: must not be declared",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -656,7 +656,7 @@ def _check_var(
		if not declared_input:
		yield Issue(
		Check.input_must_be_declared,
		f"Variable <{tbc_var.name}/{expected_input_name}>: input not found",
		f"Variable '{tbc_var.name}/{expected_input_name}': input not found",
		FilePos(tpl_path),
		f"/var:{tbc_var.name}",
		)
		@@ -669,7 +669,7 @@ def _check_var(
		if actual_gl_input.type != expected_gl_input.type:
		yield Issue(
		Check.var_type_should_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: type ({actual_gl_input.type}) doesn't match Kicker's ({expected_gl_input.type})",
		f"Variable '{tbc_var.name}/{expected_input_name}': type ({actual_gl_input.type}) doesn't match Kicker's ({expected_gl_input.type})",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -677,7 +677,7 @@ def _check_var(
		if actual_gl_input.description != expected_gl_input.description:
		yield Issue(
		Check.var_description_should_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: description doesn't match Kicker's",
		f"Variable '{tbc_var.name}/{expected_input_name}': description doesn't match Kicker's",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -685,7 +685,7 @@ def _check_var(
		if actual_gl_input.default != expected_gl_input.default:
		yield Issue(
		Check.input_default_value_must_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: default ({actual_gl_input.default}) doesn't match Kicker's ({expected_gl_input.default})",
		f"Variable '{tbc_var.name}/{expected_input_name}': default ({actual_gl_input.default}) doesn't match Kicker's ({expected_gl_input.default})",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -693,7 +693,7 @@ def _check_var(
		if actual_gl_input.options != expected_gl_input.options:
		yield Issue(
		Check.var_options_should_match,
		f"Variable <{tbc_var.name}/{expected_input_name}>: options ({actual_gl_input.options}) doesn't match Kicker's ({expected_gl_input.options})",
		f"Variable '{tbc_var.name}/{expected_input_name}': options ({actual_gl_input.options}) doesn't match Kicker's ({expected_gl_input.options})",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		@@ -705,14 +705,14 @@ def _check_var(
		if not actual_variable_value:
		yield Issue(
		Check.var_must_be_mapped,
		f"Variable <{tbc_var.name}/{expected_input_name}>: variable not mapped from input",
		f"Variable '{tbc_var.name}/{expected_input_name}': variable not mapped from input",
		getattr(declared_input, "__pos__", None),
		f"/var:{tbc_var.name}",
		)
		elif actual_variable_value != expected_variable_value:
		yield Issue(
		Check.var_value_must_be_mapping_expr,
		f"Variable <{tbc_var.name}/{expected_input_name}>: variable value ({actual_variable_value}) doesn't match expected mapping ({expected_variable_value})",
		f"Variable '{tbc_var.name}/{expected_input_name}': variable value ({actual_variable_value}) doesn't match expected mapping ({expected_variable_value})",
		getattr(actual_variable_value, "__pos__", None),
		f"/var:{tbc_var.name}",
		)