You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by GitBox <gi...@apache.org> on 2022/04/18 22:02:53 UTC
[GitHub] [tvm] driazati opened a new pull request, #11051: [ci] Add local test re-run info
driazati opened a new pull request, #11051:
URL: https://github.com/apache/tvm/pull/11051
This adds a note about `ci.py` with relevant tests when failures are detected. This should help advertise `ci.py` and make it more clear how to reproduce failures locally. This also adds a long link that makes it a short process to report a test on a build as flaky.
Thanks for contributing to TVM! Please refer to guideline https://tvm.apache.org/docs/contribute/ for useful information and tips. After the pull request is submitted, please request code reviews from [Reviewers](https://github.com/apache/incubator-tvm/blob/master/CONTRIBUTORS.md#reviewers) by @ them in the pull request thread.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] driazati commented on a diff in pull request #11051: [ci] Add local test re-run info
Posted by GitBox <gi...@apache.org>.
driazati commented on code in PR #11051:
URL: https://github.com/apache/tvm/pull/11051#discussion_r855575203
##########
tests/scripts/pytest_wrapper.py:
##########
@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import argparse
+import textwrap
+import junitparser
+from pathlib import Path
+from typing import List, Optional
+import os
+import urllib.parse
+
+
+REPO_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def lstrip(s: str, prefix: str) -> str:
+ if s.startswith(prefix):
+ s = s[len(prefix) :]
+ return s
+
+
+def classname_to_file(classname: str) -> str:
+ classname = lstrip(classname, "cython.")
+ classname = lstrip(classname, "ctypes.")
+ return classname.replace(".", "/") + ".py"
+
+
+def failed_test_ids() -> List[str]:
+ FAILURE_TYPES = (junitparser.Failure, junitparser.Error)
+ junit_dir = REPO_ROOT / "build" / "pytest-results"
+ failed_node_ids = []
+ for junit in junit_dir.glob("*.xml"):
+ xml = junitparser.JUnitXml.fromfile(str(junit))
+ for suite in xml:
+ # handle suites
+ for case in suite:
+ if len(case.result) > 0 and isinstance(case.result[0], FAILURE_TYPES):
+ node_id = classname_to_file(case.classname) + "::" + case.name
+ failed_node_ids.append(node_id)
+
+ return list(set(failed_node_ids))
+
+
+def repro_command(build_type: str, failed_node_ids: List[str]) -> Optional[str]:
+ """
+ Parse available JUnit XML files and output a command that users can run to
+ reproduce CI failures locally
+ """
+ test_args = [f"--tests {node_id}" for node_id in failed_node_ids]
+ test_args_str = " ".join(test_args)
+ return f"python3 tests/scripts/ci.py {build_type} {test_args_str}"
+
+
+def make_issue_url(failed_node_ids: List[str]) -> str:
+ names = [f"`{node_id}`" for node_id in failed_node_ids]
+ run_url = os.getenv("RUN_DISPLAY_URL", "<insert run URL>")
+ test_bullets = [f" - `{node_id}`" for node_id in failed_node_ids]
+ params = {
+ "labels": "test: flaky",
+ "title": "[Flaky Test] " + ", ".join(names),
+ "body": textwrap.dedent(
+ f"""
+ These tests were found to be flaky (intermittently failing on `main` or failed in a PR with unrelated changes). See [the docs](https://github.com/apache/tvm/blob/main/docs/contribute/ci.rst#handling-flaky-failures) for details.
Review Comment:
this one pre-fills the template with the test name and url, it is long though. we could move it further up in the log though so the relevant info is at the bottom
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] areusch commented on a diff in pull request #11051: [ci] Add local test re-run info
Posted by GitBox <gi...@apache.org>.
areusch commented on code in PR #11051:
URL: https://github.com/apache/tvm/pull/11051#discussion_r855468407
##########
tests/scripts/pytest_wrapper.py:
##########
@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import argparse
+import textwrap
+import junitparser
+from pathlib import Path
+from typing import List, Optional
+import os
+import urllib.parse
+
+
+REPO_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def lstrip(s: str, prefix: str) -> str:
+ if s.startswith(prefix):
+ s = s[len(prefix) :]
+ return s
+
+
+def classname_to_file(classname: str) -> str:
+ classname = lstrip(classname, "cython.")
+ classname = lstrip(classname, "ctypes.")
+ return classname.replace(".", "/") + ".py"
+
+
+def failed_test_ids() -> List[str]:
+ FAILURE_TYPES = (junitparser.Failure, junitparser.Error)
+ junit_dir = REPO_ROOT / "build" / "pytest-results"
+ failed_node_ids = []
+ for junit in junit_dir.glob("*.xml"):
+ xml = junitparser.JUnitXml.fromfile(str(junit))
+ for suite in xml:
+ # handle suites
+ for case in suite:
+ if len(case.result) > 0 and isinstance(case.result[0], FAILURE_TYPES):
+ node_id = classname_to_file(case.classname) + "::" + case.name
+ failed_node_ids.append(node_id)
+
+ return list(set(failed_node_ids))
+
+
+def repro_command(build_type: str, failed_node_ids: List[str]) -> Optional[str]:
+ """
+ Parse available JUnit XML files and output a command that users can run to
+ reproduce CI failures locally
+ """
+ test_args = [f"--tests {node_id}" for node_id in failed_node_ids]
+ test_args_str = " ".join(test_args)
+ return f"python3 tests/scripts/ci.py {build_type} {test_args_str}"
+
+
+def make_issue_url(failed_node_ids: List[str]) -> str:
+ names = [f"`{node_id}`" for node_id in failed_node_ids]
+ run_url = os.getenv("RUN_DISPLAY_URL", "<insert run URL>")
+ test_bullets = [f" - `{node_id}`" for node_id in failed_node_ids]
+ params = {
+ "labels": "test: flaky",
+ "title": "[Flaky Test] " + ", ".join(names),
+ "body": textwrap.dedent(
+ f"""
+ These tests were found to be flaky (intermittently failing on `main` or failed in a PR with unrelated changes). See [the docs](https://github.com/apache/tvm/blob/main/docs/contribute/ci.rst#handling-flaky-failures) for details.
Review Comment:
this is a pretty long URLEncode, should we just create issue template?
##########
tests/scripts/pytest_wrapper.py:
##########
@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import argparse
+import textwrap
+import junitparser
+from pathlib import Path
+from typing import List, Optional
+import os
+import urllib.parse
+
+
+REPO_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def lstrip(s: str, prefix: str) -> str:
+ if s.startswith(prefix):
+ s = s[len(prefix) :]
+ return s
+
+
+def classname_to_file(classname: str) -> str:
+ classname = lstrip(classname, "cython.")
+ classname = lstrip(classname, "ctypes.")
+ return classname.replace(".", "/") + ".py"
+
+
+def failed_test_ids() -> List[str]:
+ FAILURE_TYPES = (junitparser.Failure, junitparser.Error)
+ junit_dir = REPO_ROOT / "build" / "pytest-results"
+ failed_node_ids = []
+ for junit in junit_dir.glob("*.xml"):
+ xml = junitparser.JUnitXml.fromfile(str(junit))
+ for suite in xml:
+ # handle suites
+ for case in suite:
+ if len(case.result) > 0 and isinstance(case.result[0], FAILURE_TYPES):
+ node_id = classname_to_file(case.classname) + "::" + case.name
+ failed_node_ids.append(node_id)
+
+ return list(set(failed_node_ids))
+
+
+def repro_command(build_type: str, failed_node_ids: List[str]) -> Optional[str]:
+ """
+ Parse available JUnit XML files and output a command that users can run to
+ reproduce CI failures locally
+ """
+ test_args = [f"--tests {node_id}" for node_id in failed_node_ids]
+ test_args_str = " ".join(test_args)
+ return f"python3 tests/scripts/ci.py {build_type} {test_args_str}"
+
+
+def make_issue_url(failed_node_ids: List[str]) -> str:
+ names = [f"`{node_id}`" for node_id in failed_node_ids]
+ run_url = os.getenv("RUN_DISPLAY_URL", "<insert run URL>")
+ test_bullets = [f" - `{node_id}`" for node_id in failed_node_ids]
+ params = {
+ "labels": "test: flaky",
+ "title": "[Flaky Test] " + ", ".join(names),
+ "body": textwrap.dedent(
+ f"""
+ These tests were found to be flaky (intermittently failing on `main` or failed in a PR with unrelated changes). See [the docs](https://github.com/apache/tvm/blob/main/docs/contribute/ci.rst#handling-flaky-failures) for details.
+
+ ### Tests(s)\n
+ """
+ )
+ + "\n".join(test_bullets)
+ + f"\n\n### Jenkins Links\n\n - {run_url}",
+ }
+ return "https://github.com/apache/tvm/issues/new?" + urllib.parse.urlencode(params)
+
+
+def show_failure_help(failed_suites: List[str]) -> None:
+ failed_node_ids = failed_test_ids()
+
+ if len(failed_node_ids) == 0:
+ return
+
+ build_type = os.getenv("PLATFORM")
+
+ if build_type is None:
+ raise RuntimeError("build type was None, cannot show command")
+
+ repro = repro_command(build_type=build_type, failed_node_ids=failed_node_ids)
+ if repro is None:
+ print("No test failures detected")
+ return
+
+ print("=============================== PYTEST FAILURES ================================")
+ print(
+ "These pytest suites failed to execute. The results can be found in the "
+ "Jenkins 'Tests' tab or by scrolling up through the raw logs here. "
+ "If there is no test listed below, the failure likely came from a segmentation "
+ "fault which you can find in the logs above.\n"
+ )
+ if len(failed_suites) > 0:
+ print("\n".join([f" - {suite}" for suite in failed_suites]))
+ print("")
+
+ print("You can reproduce these specific failures locally with this command:\n")
+ print(textwrap.indent(repro, prefix=" "))
+ print("")
+
+ print(
+ "If you believe these test failures are spurious or are not due to this change, "
+ f"please file an issue: {make_issue_url(failed_node_ids)}"
+ )
+
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(description="Print information about a failed pytest run")
+ args, other = parser.parse_known_args()
+ try:
+ show_failure_help(failed_suites=other)
+ except Exception as e:
+ # This script shouldn't ever introduce failures since it's just there to
+ # add extra information, so ignore any errors
+ print(e)
Review Comment:
nit: could prefix this exception with some identifying info so it's clear what's being printed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] areusch merged pull request #11051: [ci] Add local test re-run info
Posted by GitBox <gi...@apache.org>.
areusch merged PR #11051:
URL: https://github.com/apache/tvm/pull/11051
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] areusch commented on a diff in pull request #11051: [ci] Add local test re-run info
Posted by GitBox <gi...@apache.org>.
areusch commented on code in PR #11051:
URL: https://github.com/apache/tvm/pull/11051#discussion_r856497358
##########
tests/scripts/pytest_wrapper.py:
##########
@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import argparse
+import textwrap
+import junitparser
+from pathlib import Path
+from typing import List, Optional
+import os
+import urllib.parse
+
+
+REPO_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def lstrip(s: str, prefix: str) -> str:
+ if s.startswith(prefix):
+ s = s[len(prefix) :]
+ return s
+
+
+def classname_to_file(classname: str) -> str:
+ classname = lstrip(classname, "cython.")
+ classname = lstrip(classname, "ctypes.")
+ return classname.replace(".", "/") + ".py"
+
+
+def failed_test_ids() -> List[str]:
+ FAILURE_TYPES = (junitparser.Failure, junitparser.Error)
+ junit_dir = REPO_ROOT / "build" / "pytest-results"
+ failed_node_ids = []
+ for junit in junit_dir.glob("*.xml"):
+ xml = junitparser.JUnitXml.fromfile(str(junit))
+ for suite in xml:
+ # handle suites
+ for case in suite:
+ if len(case.result) > 0 and isinstance(case.result[0], FAILURE_TYPES):
+ node_id = classname_to_file(case.classname) + "::" + case.name
+ failed_node_ids.append(node_id)
+
+ return list(set(failed_node_ids))
+
+
+def repro_command(build_type: str, failed_node_ids: List[str]) -> Optional[str]:
+ """
+ Parse available JUnit XML files and output a command that users can run to
+ reproduce CI failures locally
+ """
+ test_args = [f"--tests {node_id}" for node_id in failed_node_ids]
+ test_args_str = " ".join(test_args)
+ return f"python3 tests/scripts/ci.py {build_type} {test_args_str}"
+
+
+def make_issue_url(failed_node_ids: List[str]) -> str:
+ names = [f"`{node_id}`" for node_id in failed_node_ids]
+ run_url = os.getenv("RUN_DISPLAY_URL", "<insert run URL>")
+ test_bullets = [f" - `{node_id}`" for node_id in failed_node_ids]
+ params = {
+ "labels": "test: flaky",
+ "title": "[Flaky Test] " + ", ".join(names),
+ "body": textwrap.dedent(
+ f"""
+ These tests were found to be flaky (intermittently failing on `main` or failed in a PR with unrelated changes). See [the docs](https://github.com/apache/tvm/blob/main/docs/contribute/ci.rst#handling-flaky-failures) for details.
Review Comment:
yeah makes sense. i didn't see a way to make github interpolate the template for you [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-url-query) so let's go with this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org