add test for domains and filter by version and project

Author: dojutsu-user

readthedocs/doc_builder/python_environments.py

@@ -325,7 +325,8 @@ def install_core_requirements(self):
                     negative='sphinx<2',
                 ),
                 'sphinx-rtd-theme<0.5',
-                'readthedocs-sphinx-ext<0.7',
+                # 'readthedocs-sphinx-ext<0.7',
+                'git+https://github.com/readthedocs/readthedocs-sphinx-ext@master',
             ])
 
         cmd = copy.copy(pip_install_cmd)

readthedocs/search/faceted_search.py

@@ -105,7 +105,7 @@ class PageSearchBase(RTDFacetedSearch):
     _section_fields = ['sections.title^3', 'sections.content']
     _domain_fields = [
         'domains.type_display',
-        'domains.name',
+        'domains.name^2',
         'domains.display_name',
     ]
     fields = _outer_fields

readthedocs/search/tests/conftest.py

@@ -8,6 +8,8 @@
 
 from readthedocs.projects.models import Project, HTMLFile
 from readthedocs.search.documents import PageDocument
+from readthedocs.sphinx_domains.models import SphinxDomain
+
 from .dummy_data import ALL_PROJECTS, PROJECT_DATA_FILES
 
 
@@ -32,6 +34,28 @@ def all_projects(es_index, mock_processed_json, db, settings):
             file_name = file_basename + '.html'
             version = project.versions.all()[0]
             html_file = G(HTMLFile, project=project, version=version, name=file_name)
+
+            # creating sphinx domain test objects
+            file_path = get_json_file_path(project.slug, file_basename)
+            if os.path.exists(file_path):
+                with open (file_path) as f:
+                    data = json.load(f)
+                    domains = data['domains']
+
+                    for domain_data in domains:
+                        domain_role_name = domain_data.pop('role_name')
+                        domain, type_ = domain_role_name.split(':')
+
+                        G(
+                            SphinxDomain,
+                            project=project,
+                            version=version,
+                            html_file=html_file,
+                            domain=domain,
+                            type=type_,
+                            **domain_data
+                        )
+
             PageDocument().update(html_file)
 
         projects_list.append(project)
@@ -46,12 +70,17 @@ def project(all_projects):
     return all_projects[0]
 
 
+def get_json_file_path(project_slug, basename):
+    current_path = os.path.abspath(os.path.dirname(__file__))
+    file_name = f'{basename}.json'
+    file_path = os.path.join(current_path, 'data', project_slug, file_name)
+    return file_path
+
+
 def get_dummy_processed_json(instance):
     project_slug = instance.project.slug
     basename = os.path.splitext(instance.name)[0]
-    file_name = basename + '.json'
-    current_path = os.path.abspath(os.path.dirname(__file__))
-    file_path = os.path.join(current_path, "data", project_slug, file_name)
+    file_path = get_json_file_path(project_slug, basename)
 
     if os.path.exists(file_path):
         with open(file_path) as f:

readthedocs/search/tests/data/docs/support.json

@@ -17,5 +17,25 @@
             "title": "Commercial Support",
             "content": "We offer commercial support for Read the Docs, commercial hosting, as well as consulting around all documentation systems. You can contact us at [email protected] to learn more, or read more at https://readthedocs.com/services/#open-source-support."
         }
+    ],
+    "domains": [
+        {
+            "role_name": "http:post",
+            "doc_name": "api/v3.html",
+            "anchor": "post--api-v3-projects-(string-project_slug)-versions-(string-version_slug)-builds-",
+            "type_display": "post",
+            "doc_display": "API v3",
+            "name": "/api/v3/projects/(string:project_slug)/versions/(string:version_slug)/builds/",
+            "display_name": ""
+        },
+        {
+            "role_name": "http:patch",
+            "doc_name": "api/v3.html",
+            "anchor": "patch--api-v3-projects-(string-project_slug)-version-(string-version_slug)-",
+            "type_display": "patch",
+            "doc_display": "API v3",
+            "name": "/api/v3/projects/(string:project_slug)/version/(string:version_slug)/",
+            "display_name": ""
+        }
     ]
 }

readthedocs/search/tests/data/docs/wiping.json

@@ -7,5 +7,43 @@
             "title": "Wiping a Build Environment",
             "content": "Sometimes it happen that your Builds start failing because the build environment where the documentation is created is stale or broken. This could happen for a couple of different reasons like pip not upgrading a package properly or a corrupted cached Python package.In any of these cases (and many others), the solution could be just wiping out the existing build environment files and allow Read the Docs to create a new fresh one.Follow these steps to wipe the build environment:Click on the Edit button of the version you want to wipe on the right side of the page. Go to the bottom of the page and click the wipe link, next to the “Save” buttonBy wiping the documentation build environment, all the rst, md, and code files associated with it will be removed but not the documentation already built (HTML and PDF files). Your documentation will still online after wiping the build environment.Now you can re-build the version with a fresh build environment!"
         }
+    ],
+    "domains": [
+        {
+            "role_name": "http:get",
+            "doc_name": "api/v3.html",
+            "anchor": "get--api-v3-users-(str-username)",
+            "type_display": "get",
+            "doc_display": "API v3",
+            "name": "/api/v3/users/(str:username)",
+            "display_name": ""
+        },
+        {
+            "role_name": "http:get",
+            "doc_name": "api/v3.html",
+            "anchor": "get--api-v3-projects-(string-project_slug)-versions-(string-version_slug)-",
+            "type_display": "get",
+            "doc_display": "API v3",
+            "name": "/api/v3/projects/(string:project_slug)/versions/(string:version_slug)/",
+            "display_name": ""
+        },
+        {
+            "role_name": "http:get",
+            "doc_name": "api/v3.html",
+            "anchor": "get--api-v3-projects-(string-project_slug)-versions-",
+            "type_display": "get",
+            "doc_display": "API v3",
+            "name": "/api/v3/projects/(string:project_slug)/versions/",
+            "display_name": ""
+        },
+        {
+            "role_name": "http:get",
+            "doc_name": "api/v3.html",
+            "anchor": "get--api-v3-projects-(string-project_slug)-",
+            "type_display": "get",
+            "doc_display": "API v3",
+            "name": "/api/v3/projects/(string:project_slug)/",
+            "display_name": ""
+        }
     ]
 }

readthedocs/search/tests/data/kuma/docker.json

@@ -12,5 +12,25 @@
             "title": "Docker Images",
             "content": "Docker images are used in development, usually with the local working files mounted in the images to set behaviour.. Images are built by Jenkins, after tests pass, and are published to DockerHub. We try to store the configuration in the environment, so that the published images can be used in deployments by setting environment variables to deployment-specific values.. Here are some of the images used in the Kuma project:. kuma. The kuma Docker image builds on the kuma_base image, installing a kuma branch and building the assets needed for running as a webservice. The environment can be customized for different deployments.. The image can be recreated locally with make build-kuma.. The image tagged latest is used by default for development. It can be created locally with make build-kuma VERSION=latest. The official latest image is created from the master branch in Jenkins and published to DockerHub.. kuma_base. The kuma_base Docker image contains the OS and libraries (C, Python, and Node.js) that support the kuma project. The kuma image extends this by installing the kuma source and building assets needed for production.. The image can be recreated locally with make build-base.. The image tagged latest is used by default for development. It can be created localled with make build-base VERSION=latest. The official latest image is created from the master branch in Jenkins and published to DockerHub. kumascript. The kumascript Docker image contains the kumascript rendering engine and support files. The environment can be customized for different deployments.. The image can be recreated locally with make build-kumascript.. The image tagged latest is used by default for development. It can be created locally with make build-kumascript KS_VERSION=latest. The official latest image is created from the master branch in Jenkins and published to DockerHub.. integration-tests. The integration-tests Docker image contains browser-based integration tests that check the functionality of a running Kuma deployment.. The image can be recreated locally with docker build -f docker/images/integration-tests/ ., but this is only necessary for image development. Most developers will follow the Client-side testing documentation to develop and run these integration tests.. The image is built and used in Jenkins in the stage-integration-tests and prod-integration-tests pipelines, configured by scripts in the Jenkinsfiles folder. It is not published to DockerHub."
         }
+    ],
+    "domains": [
+        {
+            "role_name": "py:module",
+            "doc_name": "autoapi/notfound/utils/index.html",
+            "anchor": "module-notfound.utils",
+            "type_display": "module",
+            "doc_display": "notfound.utils",
+            "name": "notfound.utils",
+            "display_name": ""
+        },
+        {
+            "role_name": "py:function",
+            "doc_name": "autoapi/notfound/utils/index.html",
+            "anchor": "notfound.utils.replace_uris",
+            "type_display": "function",
+            "doc_display": "notfound.utils",
+            "name": "notfound.utils.replace_uris",
+            "display_name": ""
+        }
     ]
 }

readthedocs/search/tests/data/kuma/documentation.json

@@ -12,5 +12,25 @@
             "title": "Generating documentation",
             "content": "Sphinx uses a Makefile in the docs subfolder to build documentation in several formats. MDN only uses the HTML format, and the generated document index is at docs/_build/html/index.html.. To generate the documentation in a virtualenv on the host machine, first install the requirements:. pip install -r requirements/docs.txt. Then switch to the docs folder to use the Makefile:. cd docs make html python -m webbrowser file://${PWD}/_build/html/index.html. To generate the documentation with Docker:. docker-compose run --rm --user $(id -u) web sh -c \"\\ virtualenv /tmp/.venvs/docs && \\ . /tmp/.venvs/docs/bin/activate && \\ pip install -r /app/requirements/docs.txt && \\ cd /app/docs && \\ make html\" python -m webbrowser file://${PWD}/docs/_build/html/index.html. A virtualenv is required, to avoid a pip bug when changing the version of a system-installed package."
         }
+    ],
+    "domains": [
+        {
+            "role_name": "py:module",
+            "doc_name": "autoapi/notfound/index.html",
+            "anchor": "module-notfound",
+            "type_display": "module",
+            "doc_display": "notfound",
+            "name": "notfound",
+            "display_name": ""
+        },
+        {
+            "role_name": "py:data",
+            "doc_name": "autoapi/notfound/index.html",
+            "anchor": "notfound.version",
+            "type_display": "data",
+            "doc_display": "notfound",
+            "name": "notfound.version",
+            "display_name": ""
+        }
     ]
 }

readthedocs/search/tests/data/pipeline/installation.json

@@ -22,5 +22,16 @@
             "title": "Recommendations",
             "content": "Pipeline’s default CSS and JS compressor is Yuglify. Yuglify wraps UglifyJS and cssmin, applying the default YUI configurations to them. It can be downloaded from: https://github.com/yui/yuglify/.. If you do not install yuglify, make sure to disable the compressor in your settings."
         }
+    ],
+    "domains": [
+        {
+            "role_name": "std:confval",
+            "doc_name": "configuration.html",
+            "anchor": "confval-notfound_default_language",
+            "type_display": "confval",
+            "doc_display": "Configuration",
+            "name": "notfound_default_language",
+            "display_name": ""
+        }
     ]
 }

readthedocs/search/tests/data/pipeline/signals.json

@@ -17,5 +17,25 @@
             "title": "js_compressed",
             "content": "pipeline.signals.js_compressed. Whenever a js package is compressed, this signal is sent after the compression.. Arguments sent with this signal :. sender:. The Packager class that compressed the group.. package:. The package actually compressed."
         }
+    ],
+    "domains": [
+        {
+            "role_name": "py:method",
+            "doc_name": "autoapi/notfound/extension/index.html",
+            "anchor": "notfound.extension.OrphanMetadataCollector.process_doc",
+            "type_display": "method",
+            "doc_display": "notfound.extension",
+            "name": "notfound.extension.OrphanMetadataCollector.process_doc",
+            "display_name": ""
+        },
+        {
+            "role_name": "py:method",
+            "doc_name": "autoapi/notfound/extension/index.html",
+            "anchor": "notfound.extension.OrphanMetadataCollector.clear_doc",
+            "type_display": "method",
+            "doc_display": "notfound.extension",
+            "name": "notfound.extension.OrphanMetadataCollector.clear_doc",
+            "display_name": ""
+        }
     ]
 }