From 95483fc26dc1b4cd9b2a9c3f13c5a0c288917cdb Mon Sep 17 00:00:00 2001 From: haiyangToAI Date: Mon, 26 Sep 2022 15:36:42 +0200 Subject: [PATCH] fixed test_file with needs_extra_options --- tests/doc_test/doc_test_file/Makefile | 20 +++ tests/doc_test/doc_test_file/conf.py | 194 +++++++++++++++++++++++++ tests/doc_test/doc_test_file/index.rst | 31 ++++ tests/doc_test/doc_test_file/make.bat | 36 +++++ tests/test_test_file.py | 38 +++++ 5 files changed, 319 insertions(+) create mode 100644 tests/doc_test/doc_test_file/Makefile create mode 100644 tests/doc_test/doc_test_file/conf.py create mode 100644 tests/doc_test/doc_test_file/index.rst create mode 100644 tests/doc_test/doc_test_file/make.bat create mode 100644 tests/test_test_file.py diff --git a/tests/doc_test/doc_test_file/Makefile b/tests/doc_test/doc_test_file/Makefile new file mode 100644 index 0000000..47330b8 --- /dev/null +++ b/tests/doc_test/doc_test_file/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = needstestdocs +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/tests/doc_test/doc_test_file/conf.py b/tests/doc_test/doc_test_file/conf.py new file mode 100644 index 0000000..0bd2db7 --- /dev/null +++ b/tests/doc_test/doc_test_file/conf.py @@ -0,0 +1,194 @@ +# +# testreport test docs documentation build configuration file, created by +# sphinx-quickstart on Tue Mar 28 11:37:14 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +sys.path.insert(0, os.path.abspath("../../sphinxcontrib")) + +# -- General configuration ------------------------------------------------ + +# If your documentation testreport a minimal Sphinx version, state it here. +# +# testreport_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +extensions = ["sphinx_needs", "sphinxcontrib.test_reports"] + +needs_types = [ + { + "directive": "story", + "title": "User Story", + "prefix": "US_", + "color": "#BFD8D2", + "style": "node", + }, + { + "directive": "spec", + "title": "Specification", + "prefix": "SP_", + "color": "#FEDCD2", + "style": "node", + }, + { + "directive": "impl", + "title": "Implementation", + "prefix": "IM_", + "color": "#DF744A", + "style": "node", + }, + { + "directive": "test", + "title": "Test Case", + "prefix": "TC_", + "color": "#DCB239", + "style": "node", + }, +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +needs_extra_options = ["asil", "uses_secure"] + +# General information about the project. +project = "test-report test docs" +copyright = "2017, team useblocks" +author = "team useblocks" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = "1.0" +# The full version, including alpha/beta/rc tags. +release = "1.0" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ["_static"] + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = "testreporttestdocsdoc" + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "testreporttestdocs.tex", + "testreport test docs Documentation", + "team useblocks", + "manual", + ), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "testreporttestdocs", + "testreport test docs Documentation", + [author], + 1, + ) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "testreporttestdocs", + "testreport test docs Documentation", + author, + "testreporttestdocs", + "One line description of project.", + "Miscellaneous", + ), +] diff --git a/tests/doc_test/doc_test_file/index.rst b/tests/doc_test/doc_test_file/index.rst new file mode 100644 index 0000000..8a02869 --- /dev/null +++ b/tests/doc_test/doc_test_file/index.rst @@ -0,0 +1,31 @@ +Basic Document FOR TEST FILE +============================ + +.. spec:: TEST_1 + :id: TEST_1 + :tags: A + :asil: D + +.. spec:: TEST_2 + :id: TEST_2 + :tags: A + +.. spec:: TEST_3 + :id: TEST_3 + :tags: A, B + :uses_secure: True + +.. spec:: TEST_4 + :id: TEST_4 + :tags: B + :uses_secure: True + + +.. test-file:: My Test Data + :file: ../utils/xml_data.xml + :id: TESTFILE_1 + + +Need number with extra options: :need_count:`asil=='D'` + +Need number with extra options: :need_count:`uses_secure=='True'` diff --git a/tests/doc_test/doc_test_file/make.bat b/tests/doc_test/doc_test_file/make.bat new file mode 100644 index 0000000..489ed7d --- /dev/null +++ b/tests/doc_test/doc_test_file/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=needstestdocs + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/tests/test_test_file.py b/tests/test_test_file.py new file mode 100644 index 0000000..1f6c379 --- /dev/null +++ b/tests/test_test_file.py @@ -0,0 +1,38 @@ +from pathlib import Path + +import pytest + + +@pytest.mark.parametrize( + "test_app", + [{"buildername": "html", "srcdir": "doc_test/doc_test_file"}], + indirect=True, +) +def test_doc_build_html(test_app): + app = test_app + app.build() + html = Path(app.outdir, "index.html").read_text() + assert html + + +@pytest.mark.parametrize( + "test_app", + [{"buildername": "html", "srcdir": "doc_test/doc_test_file"}], + indirect=True, +) +def test_test_file_needs_extra_options_no_warning(test_app): + import subprocess + + app = test_app + + srcdir = Path(app.srcdir) + out_dir = srcdir / "_build" + + out = subprocess.run( + ["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True + ) + + assert out.returncode == 0 + + # Check no warnings + assert "WARNING" not in out.stdout.decode("utf-8")