wehub-resource-sync
63 lines
2.1 KiB
Python
63 lines
2.1 KiB
Python
#
|
|
# SPDX-FileCopyrightText: Copyright (c) 1993-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
"""
|
|
Tests that ensure the user experience is nice. For example, making sure that
|
|
README links work.
|
|
"""
|
|
|
|
import glob
|
|
import os
|
|
import re
|
|
|
|
import pytest
|
|
import requests
|
|
|
|
from tests.helper import ROOT_DIR
|
|
|
|
readme_test_cases = [
|
|
path
|
|
for path in glob.glob(os.path.join(ROOT_DIR, "**", "*.md"), recursive=True)
|
|
if not path.startswith(os.path.join(ROOT_DIR, "build"))
|
|
]
|
|
|
|
|
|
class TestReadme:
|
|
@pytest.mark.parametrize("readme", readme_test_cases)
|
|
def test_links_valid(self, readme):
|
|
MD_LINK_PAT = re.compile(r"\[.*?\]\((.*?)\)")
|
|
|
|
readme_dir = os.path.dirname(readme)
|
|
with open(readme, "r") as f:
|
|
links = MD_LINK_PAT.findall(f.read())
|
|
|
|
for link in links:
|
|
link, _, _ = link.partition("#") # Ignore section links for now
|
|
if link.startswith("https://"):
|
|
assert requests.get(link).status_code == 200
|
|
else:
|
|
assert (
|
|
os.path.pathsep * 2 not in link
|
|
), "Duplicate slashes break links in GitHub"
|
|
# NOTE: We cannot use repo-root-relative links in Markdown since Polygraphy is also
|
|
# a subfolder of the OSS repo.
|
|
assert not link.startswith("/")
|
|
link_abs_path = os.path.abspath(os.path.join(readme_dir, link))
|
|
assert os.path.exists(
|
|
link_abs_path
|
|
), f"In README: '{readme}', link: '{link}' does not exist. Note: Full path was: '{link_abs_path}'"
|