Skip to content

Add unit tests for function renderer #196

Add unit tests for function renderer

Add unit tests for function renderer #196

This check has been archived and is scheduled for deletion. Learn more about checks retention
GitHub Actions / Test report - 3.11 failed Sep 24, 2023 in 0s

Test report - 3.11 ❌

Tests failed

❌ test-results.xml

121 tests were completed in 19s with 119 passed, 1 failed and 1 skipped.

Test suite Passed Failed Skipped Time
pytest 119✔️ 1❌ 1✖️ 19s

❌ pytest

tests.test_incremental
  ✔️ test_incremental_js
  ✔️ test_incremental_ts
tests.test_init
  ✔️ test_relative_path_root
tests.test_ir
  ✔️ test_default
  ✔️ test_missing_default
tests.test_parsers
  ✔️ test_escapes
  ✔️ test_relative_dirs
tests.test_paths
  ✔️ test_global
  ✔️ test_node_modules1
  ✔️ test_node_modules2
  ✔️ test_env1
  ✔️ test_env2
  ✔️ test_err
tests.test_renderers
  ✔️ test_func_render_simple
  ✔️ test_func_render_shortnames
  ✔️ test_func_render_flags
  ✔️ test_func_render_description
  ✔️ test_func_render_params
  ✔️ test_func_render_returns
  ❌ test_func_render_type_params
	function_render = <function function_render.<locals>.function_render at 0x7f22ad0c2c00>
  ✔️ test_func_render_param_type
  ✔️ test_func_render_param_options
  ✔️ test_func_render_param_exceptions
  ✔️ test_func_render_callouts
tests.test_suffix_tree
  ✔️ test_things
  ✔️ test_full_path
  ✔️ test_terminal_insertion
  ✔️ test_ambiguous_even_if_full_path
  ✔️ test_ambiguous_paths_reported
  ✔️ test_value_ambiguity
tests.test_testing
  ✔️ test_dict_where
tests.test_build_js.test_build_js.Tests
  ✔️ test_autoattribute
  ✔️ test_autoattribute_deprecated
  ✔️ test_autoattribute_example
  ✔️ test_autoattribute_see
  ✔️ test_autoclass
  ✔️ test_autoclass_alphabetical
  ✔️ test_autoclass_deprecated
  ✔️ test_autoclass_example
  ✔️ test_autoclass_exclude_members
  ✔️ test_autoclass_members
  ✔️ test_autoclass_members_list
  ✔️ test_autoclass_members_list_star
  ✔️ test_autoclass_private_members
  ✔️ test_autoclass_see
  ✔️ test_autofunction_callback
  ✔️ test_autofunction_defaults_in_code
  ✔️ test_autofunction_defaults_in_doclet
  ✔️ test_autofunction_deprecated
  ✔️ test_autofunction_destructured_params
  ✔️ test_autofunction_example
  ✔️ test_autofunction_explicit
  ✔️ test_autofunction_long
  ✔️ test_autofunction_minimal
  ✔️ test_autofunction_see
  ✔️ test_autofunction_short
  ✔️ test_autofunction_static
  ✔️ test_autofunction_typedef
  ✔️ test_autofunction_variadic
  ✔️ test_field_list_unwrapping
  ✔️ test_getter_setter
  ✔️ test_no_shadowing
  ✔️ test_restructuredtext_injection
  ✔️ test_union_types
tests.test_build_ts.test_build_ts.TextBuilderTests
  ✔️ test_abstract_extends_and_implements
  ✔️ test_autoclass_constructor
  ✔️ test_autoclass_order
  ✔️ test_autoclass_star_order
  ✔️ test_constructorless_class
  ✔️ test_exported_from
  ✔️ test_optional_members
tests.test_build_ts.test_build_ts.HtmlBuilderTests
  ✔️ test_extends_links
  ✔️ test_implements_links
  ✔️ test_xrefs
tests.test_common_mark.test_common_mark.Tests
  ✔️ test_build_success
tests.test_dot_dot_paths.test_dot_dot_paths.Tests
  ✔️ test_dot_dot
tests.test_jsdoc_analysis.test_jsdoc
  ✔️ test_doclet_full_path
tests.test_jsdoc_analysis.test_jsdoc.FunctionTests
  ✔️ test_top_level_and_function
tests.test_jsdoc_analysis.test_jsdoc.ClassTests
  ✔️ test_class
tests.test_typedoc_analysis.test_typedoc_analysis.PopulateIndexTests
  ✔️ test_top_level_function
tests.test_typedoc_analysis.test_typedoc_analysis.PathSegmentsTests
  ✔️ test_class
  ✔️ test_constructor
  ✔️ test_function
  ✔️ test_getter
  ✔️ test_instance_property
  ✔️ test_interface_property
  ✔️ test_method
  ✔️ test_namespaced_var
  ✖️ test_relative_paths
  ✔️ test_setter
  ✔️ test_static_method
  ✔️ test_static_property
  ✔️ test_weird_name
tests.test_typedoc_analysis.test_typedoc_analysis.ConvertNodeTests
  ✔️ test_class1
  ✔️ test_constructor
  ✔️ test_function
  ✔️ test_getter
  ✔️ test_interface
  ✔️ test_interface_function_member
  ✔️ test_properties
  ✔️ test_setter
  ✔️ test_variable
tests.test_typedoc_analysis.test_typedoc_analysis.TypeNameTests
  ✔️ test_array
  ✔️ test_basic
  ✔️ test_class_constrained
  ✔️ test_code_in_description
  ✔️ test_constrained_by_constructor
  ✔️ test_constrained_by_interface
  ✔️ test_constrained_by_key
  ✔️ test_constrained_by_property
  ✔️ test_destructured
  ✔️ test_funcarg
  ✔️ test_generic_function
  ✔️ test_generic_member
  ✔️ test_interface_readonly_member
  ✔️ test_intersection
  ✔️ test_literal_types
  ✔️ test_named_interface
  ✔️ test_optional_property
  ✔️ test_unions
  ✔️ test_utility_types

Annotations

Check failure on line 0 in test-results.xml

See this annotation in the file changed.

@github-actions github-actions / Test report - 3.11

pytest ► tests.test_renderers ► test_func_render_type_params

Failed test found in:
  test-results.xml
Error:
  function_render = <function function_render.<locals>.function_render at 0x7f22ad0c2c00>
Raw output
function_render = <function function_render.<locals>.function_render at 0x7f22ad0c2c00>

    def test_func_render_type_params(function_render):
>       assert function_render(
            params=[Param("a", type="T"), Param("b", type="S")],
            type_params=[
                TypeParam("T", "", "a type param"),
                TypeParam("S", "", "second type param"),
            ],
        ) == dedent(
            """\
            .. js:function:: blah(a, b)
    
               :typeparam T: a type param
               :typeparam S: second type param
               :param a:
               :param b:
               :type a: **T**
               :type b: **S**
            """
        )
E       AssertionError: assert '.. js:functi...pe b: **S**\n' == '.. js:functi...pe b: **S**\n'
E         Skipping 96 identical leading characters in diff, use -v to show
E         -  :param a:
E         +  :param a: 
E         ?           +
E         -    :param b:
E         +    :param b: 
E         ?             +
E              :type a: **T**
E              :type b: **S**

tests/test_renderers.py:140: AssertionError