Skip to content

Commit 8d914d9

Browse files
authored
[connectors-qa] Remove unrelated docs check (#38018)
1 parent 714c836 commit 8d914d9

File tree

4 files changed

+11
-35
lines changed

4 files changed

+11
-35
lines changed

airbyte-ci/connectors/connectors_qa/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,23 @@ poe lint
108108

109109
## Changelog
110110

111+
### 1.3.2
112+
113+
Removed documentation checks in `MedatadaCheck` since it's already verified in `DocumentationCheck`.
114+
111115
### 1.3.1
112116

113117
Remove requirements on DockerHub credentials to run metadata validation.
114118

115119
### 1.3.0
116120

117-
Added `CheckConnectorMaxSecondsBetweenMessagesValue` check that verifies presence of `maxSecondsBetweenMessages` value in `metadata.yaml` file for all source certified connectors.
121+
Added `CheckConnectorMaxSecondsBetweenMessagesValue` check that verifies presence of
122+
`maxSecondsBetweenMessages` value in `metadata.yaml` file for all source certified connectors.
118123

119124
### 1.2.0
120125

121-
Added `ValidateBreakingChangesDeadlines` check that verifies the minimal compliance of breaking change rollout deadline.
126+
Added `ValidateBreakingChangesDeadlines` check that verifies the minimal compliance of breaking
127+
change rollout deadline.
122128

123129
### 1.1.0
124130

airbyte-ci/connectors/connectors_qa/pyproject.toml

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
[tool.poetry]
22
name = "connectors-qa"
3-
version = "1.3.1"
3+
version = "1.3.2"
44
description = "A package to run QA checks on Airbyte connectors, generate reports and documentation."
55
authors = ["Airbyte <[email protected]>"]
66
readme = "README.md"
7-
packages = [
8-
{ include = "connectors_qa", from = "src" },
9-
]
7+
packages = [{ include = "connectors_qa", from = "src" }]
108
[tool.poetry.dependencies]
119
python = "^3.10"
1210
airbyte-connectors-base-images = { path = "../base_images", develop = false }

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/metadata.py

-5
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ class ValidateMetadata(MetadataCheck):
2020
description = f"Connectors must have a `{consts.METADATA_FILE_NAME}` file at the root of their directory. This file is used to build our connector registry. Its structure must follow our metadata schema. Field values are also validated. This is to ensure that all connectors have the required metadata fields and that the metadata is valid. More details in this [documentation]({consts.METADATA_DOCUMENTATION_URL})."
2121

2222
def _run(self, connector: Connector) -> CheckResult:
23-
if not connector.documentation_file_path or not connector.documentation_file_path.exists():
24-
return self.fail(
25-
connector=connector,
26-
message="User facing documentation file is missing. Please create it",
27-
)
2823
deserialized_metadata, error = validate_and_load(
2924
connector.metadata_file_path,
3025
PRE_UPLOAD_VALIDATORS,

airbyte-ci/connectors/connectors_qa/tests/unit_tests/test_checks/test_metadata.py

+1-24
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,6 @@
1010

1111
class TestValidateMetadata:
1212

13-
def test_fail_when_documentation_file_path_is_none(self, mocker):
14-
# Arrange
15-
connector = mocker.MagicMock(documentation_file_path=None)
16-
17-
# Act
18-
result = metadata.ValidateMetadata()._run(connector)
19-
20-
# Assert
21-
assert result.status == CheckStatus.FAILED
22-
assert result.message == "User facing documentation file is missing. Please create it"
23-
24-
def test_fail_when_documentation_file_path_does_not_exist(self, mocker, tmp_path):
25-
# Arrange
26-
27-
connector = mocker.MagicMock(documentation_file_path=tmp_path / "doc.md")
28-
29-
# Act
30-
result = metadata.ValidateMetadata()._run(connector)
31-
32-
# Assert
33-
assert result.status == CheckStatus.FAILED
34-
assert result.message == "User facing documentation file is missing. Please create it"
35-
3613
def test_fail_when_deserialization_fails(self, mocker, tmp_path):
3714
# Arrange
3815
mocker.patch.object(metadata, "validate_and_load", return_value=(None, "error"))
@@ -209,7 +186,7 @@ def test_fail_when_field_missing(self, mocker):
209186
def test_pass_when_field_present(self, mocker):
210187
# Arrange
211188
connector = mocker.MagicMock(metadata={"supportLevel": "certified", "maxSecondsBetweenMessages": 1})
212-
189+
213190
# Act
214191
result = metadata.CheckConnectorMaxSecondsBetweenMessagesValue()._run(connector)
215192

0 commit comments

Comments
 (0)