mirror of
https://github.com/facebookresearch/pytorch3d.git
synced 2025-08-02 03:42:50 +08:00
e5c58a8a8b
Summary: New test that notes and tutorials are listed in the website metadata, so that they will be included in the website build. Reviewed By: nikhilaravi Differential Revision: D30223799 fbshipit-source-id: 2dca9730b54e68da2fd430a7b47cb7e18814d518
109 lines
4.2 KiB
Python
109 lines
4.2 KiB
Python
# Copyright (c) Facebook, Inc. and its affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the BSD-style license found in the
|
|
# LICENSE file in the root directory of this source tree.
|
|
|
|
import json
|
|
import os
|
|
import unittest
|
|
from collections import Counter
|
|
|
|
from common_testing import get_pytorch3d_dir, get_tests_dir
|
|
|
|
|
|
# This file groups together tests which look at the code without running it.
|
|
# When running the tests inside conda's build, the code is not available.
|
|
in_conda_build = os.environ.get("CONDA_BUILD_STATE", "") == "TEST"
|
|
in_re_worker = os.environ.get("INSIDE_RE_WORKER") is not None
|
|
|
|
|
|
class TestBuild(unittest.TestCase):
|
|
@unittest.skipIf(in_conda_build or in_re_worker, "In conda build, or RE worker")
|
|
def test_name_clash(self):
|
|
# For setup.py, all translation units need distinct names, so we
|
|
# cannot have foo.cu and foo.cpp, even in different directories.
|
|
test_dir = get_tests_dir()
|
|
source_dir = test_dir.parent / "pytorch3d"
|
|
|
|
stems = []
|
|
for extension in [".cu", ".cpp"]:
|
|
files = source_dir.glob(f"**/*{extension}")
|
|
stems.extend(f.stem for f in files)
|
|
|
|
counter = Counter(stems)
|
|
for k, v in counter.items():
|
|
self.assertEqual(v, 1, f"Too many files with stem {k}.")
|
|
|
|
@unittest.skipIf(in_conda_build or in_re_worker, "In conda build, or RE worker")
|
|
def test_copyright(self):
|
|
test_dir = get_tests_dir()
|
|
root_dir = test_dir.parent
|
|
|
|
extensions = ("py", "cu", "cuh", "cpp", "h", "hpp", "sh")
|
|
|
|
expect = "Copyright (c) Facebook, Inc. and its affiliates.\n"
|
|
|
|
files_missing_copyright_header = []
|
|
|
|
for extension in extensions:
|
|
for path in root_dir.glob(f"**/*.{extension}"):
|
|
if str(path).endswith(
|
|
"pytorch3d/transforms/external/kornia_angle_axis_to_rotation_matrix.py"
|
|
):
|
|
continue
|
|
if str(path).endswith("pytorch3d/csrc/pulsar/include/fastermath.h"):
|
|
continue
|
|
with open(path) as f:
|
|
firstline = f.readline()
|
|
if firstline.startswith(("# -*-", "#!", "/*")):
|
|
firstline = f.readline()
|
|
if not firstline.endswith(expect):
|
|
files_missing_copyright_header.append(str(path))
|
|
|
|
if len(files_missing_copyright_header) != 0:
|
|
self.fail("\n".join(files_missing_copyright_header))
|
|
|
|
@unittest.skipIf(in_conda_build or in_re_worker, "In conda build, or RE worker")
|
|
def test_valid_ipynbs(self):
|
|
# Check that the ipython notebooks are valid json
|
|
root_dir = get_pytorch3d_dir()
|
|
tutorials_dir = root_dir / "docs" / "tutorials"
|
|
tutorials = sorted(tutorials_dir.glob("*.ipynb"))
|
|
|
|
for tutorial in tutorials:
|
|
with open(tutorial) as f:
|
|
json.load(f)
|
|
|
|
@unittest.skipIf(in_conda_build or in_re_worker, "In conda build, or RE worker")
|
|
def test_enumerated_ipynbs(self):
|
|
# Check that the tutorials are all referenced in tutorials.json.
|
|
root_dir = get_pytorch3d_dir()
|
|
tutorials_dir = root_dir / "docs" / "tutorials"
|
|
tutorials_on_disk = sorted(i.stem for i in tutorials_dir.glob("*.ipynb"))
|
|
|
|
json_file = root_dir / "website" / "tutorials.json"
|
|
with open(json_file) as f:
|
|
cfg_dict = json.load(f)
|
|
listed_in_json = []
|
|
for section in cfg_dict.values():
|
|
listed_in_json.extend(item["id"] for item in section)
|
|
|
|
self.assertListEqual(sorted(listed_in_json), tutorials_on_disk)
|
|
|
|
@unittest.skipIf(in_conda_build or in_re_worker, "In conda build, or RE worker")
|
|
def test_enumerated_notes(self):
|
|
# Check that the notes are all referenced in sidebars.json.
|
|
root_dir = get_pytorch3d_dir()
|
|
notes_dir = root_dir / "docs" / "notes"
|
|
notes_on_disk = sorted(i.stem for i in notes_dir.glob("*.md"))
|
|
|
|
json_file = root_dir / "website" / "sidebars.json"
|
|
with open(json_file) as f:
|
|
cfg_dict = json.load(f)
|
|
listed_in_json = []
|
|
for section in cfg_dict["docs"].values():
|
|
listed_in_json.extend(section)
|
|
|
|
self.assertListEqual(sorted(listed_in_json), notes_on_disk)
|