diff --git a/docs/changelog.rst b/docs/changelog.rst index 82b40b641..3d31cc4ce 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -14,6 +14,10 @@ License (`#336 `_) * Bugfix: :ref:`needtable` need parts 'incoming' column is empty (`#336 `_) +* Bugfix: :ref:`needs_warning` not written to error log. + (`#344 `_) +* Improvement: Providing :ref:`needs_warnings_always_warn` to raise sphinx-warnings for each not passed :ref:`needs_warnings`. + (`#344 `_) 0.7.1 ----- diff --git a/docs/configuration.rst b/docs/configuration.rst index a69ce6d2e..c8d41a2a3 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -988,6 +988,28 @@ Example output: Due to the nature of sphinx logging, a sphinx-warning may be printed wherever in the log. +.. _needs_warnings_always_warn: + +needs_warnings_always_warn +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This option if set to ``True``, will allow to log not passed :ref:`needs_warnings` into a given file if using your sphinx build +command with ``-w``. + +Default: ``False``. + +For example, set this option to True: + +.. code-block:: rst + + needs_warnings_always_warn = True + +Using sphinx build command ``sphinx-build -M html {srcdir} {outdir} -w error.log``, all the not passed :ref:`needs_warnings` will be +logged into file error.log as you specified. + +If use ``sphinx-build -M html {srcdir} {outdir} -W -w error.log``, the first not passed :ref:`needs_warnings` will stop the build and +be logged into the file error.log. + .. _needs_layouts: needs_layouts diff --git a/sphinxcontrib/needs/needs.py b/sphinxcontrib/needs/needs.py index db92ec812..01f088786 100644 --- a/sphinxcontrib/needs/needs.py +++ b/sphinxcontrib/needs/needs.py @@ -190,6 +190,7 @@ def setup(app): app.add_config_value("needs_flow_link_types", ["links"], "html") app.add_config_value("needs_warnings", {}, "html") + app.add_config_value("needs_warnings_always_warn", False, "html", types=[bool]) app.add_config_value("needs_layouts", {}, "html") app.add_config_value("needs_default_layout", "clean", "html") app.add_config_value("needs_default_style", None, "html") diff --git a/sphinxcontrib/needs/warnings.py b/sphinxcontrib/needs/warnings.py index d906adaba..16ada5c09 100644 --- a/sphinxcontrib/needs/warnings.py +++ b/sphinxcontrib/needs/warnings.py @@ -41,19 +41,30 @@ def process_warnings(app, exception): warnings = app.config.needs_warnings + warnings_always_warn = app.config.needs_warnings_always_warn + with logging.pending_logging(): logger.info("\nChecking sphinx-needs warnings") warning_raised = False for warning_name, warning_filter in warnings.items(): result = filter_needs(needs.values(), warning_filter) if len(result) == 0: - logger.info(" {}: passed".format(warning_name)) + logger.info("{}: passed".format(warning_name)) else: need_ids = [x["id"] for x in result] - logger.info(" {}: failed".format(warning_name)) - logger.info(" \t\tfailed needs: {} ({})".format(len(need_ids), ", ".join(need_ids))) - logger.info(" \t\tused filter: {}".format(warning_filter)) - warning_raised = True + if warnings_always_warn: + logger.warning( + "{}: failed\n\t\tfailed needs: {} ({})\n\t\tused filter: {}".format( + warning_name, len(need_ids), ", ".join(need_ids), warning_filter + ) + ) + else: + logger.info( + "{}: failed\n\t\tfailed needs: {} ({})\n\t\tused filter: {}".format( + warning_name, len(need_ids), ", ".join(need_ids), warning_filter + ) + ) + warning_raised = True if warning_raised: logger.warning("Sphinx-Needs warnings were raised. See console / log output for details.") diff --git a/tests/doc_test/doc_needs_warnings/Makefile b/tests/doc_test/doc_needs_warnings/Makefile new file mode 100644 index 000000000..9c4e674fb --- /dev/null +++ b/tests/doc_test/doc_needs_warnings/Makefile @@ -0,0 +1,21 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = needstestdocs +SOURCEDIR = . +BUILDDIR = _build +ERRORLOG = error.log + +# 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)" -W --keep-going -w $(ERRORLOG) $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/tests/doc_test/doc_needs_warnings/conf.py b/tests/doc_test/doc_needs_warnings/conf.py new file mode 100644 index 000000000..3399e8100 --- /dev/null +++ b/tests/doc_test/doc_needs_warnings/conf.py @@ -0,0 +1,169 @@ +# -*- coding: utf-8 -*- +# +# needs 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 needs a minimal Sphinx version, state it here. +# +# needs_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 = ["sphinxcontrib.needs"] + +needs_table_style = "TABLE" + + +needs_types = [ + dict(directive="story", title="User Story", prefix="US_", color="#BFD8D2", style="node"), + dict(directive="spec", title="Specification", prefix="SP_", color="#FEDCD2", style="node"), + dict(directive="impl", title="Implementation", prefix="IM_", color="#DF744A", style="node"), + dict(directive="test", title="Test Case", prefix="TC_", color="#DCB239", style="node"), +] + +plantuml = "java -jar %s" % os.path.join(os.path.dirname(__file__), "..", "..", "..", "docs", "utils", "plantuml.jar") +plantuml_output_format = "svg" + +needs_warnings = { + "invalid_status": "status not in ['open', 'closed', 'done']", +} + +# Needs option to set True or False to raise sphinx-warning for each not passed warning check +# default is False +needs_warnings_always_warn = True + +# 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" + +# General information about the project. +project = "needs 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 = None + +# 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 = "needstestdocsdoc" + +# -- 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, "needstestdocs.tex", "needs 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, "needstestdocs", "needs 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, + "needstestdocs", + "needs test docs Documentation", + author, + "needstestdocs", + "One line description of project.", + "Miscellaneous", + ), +] diff --git a/tests/doc_test/doc_needs_warnings/index.rst b/tests/doc_test/doc_needs_warnings/index.rst new file mode 100644 index 000000000..15d5555a8 --- /dev/null +++ b/tests/doc_test/doc_needs_warnings/index.rst @@ -0,0 +1,13 @@ +TEST DOCUMENT NEEDS WARNINGS +============================ + +.. spec:: Command line interface + :id: SP_TOO_001 + :status: implemented + :tags: test;test2 + + The Tool awesome shall have a command line interface. + +.. story:: A story + :status: in progress + :tags: 1 diff --git a/tests/doc_test/doc_needs_warnings/make.bat b/tests/doc_test/doc_needs_warnings/make.bat new file mode 100644 index 000000000..489ed7dfd --- /dev/null +++ b/tests/doc_test/doc_needs_warnings/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_needs_warning.py b/tests/test_needs_warning.py new file mode 100644 index 000000000..87f4cbc8a --- /dev/null +++ b/tests/test_needs_warning.py @@ -0,0 +1,14 @@ +from sphinx_testing import with_app + + +@with_app(buildername="html", srcdir="doc_test/doc_needs_warnings") # , warningiserror=True) +def test_needs_warnings(app, status, warning): + app.build() + + # stdout warnings + warnings = warning.getvalue() + + # check warnings contents + assert "WARNING: invalid_status: failed" in warnings + assert "failed needs: 2 (SP_TOO_001, US_63252)" in warnings + assert "used filter: status not in ['open', 'closed', 'done']" in warnings