[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
areusch merged 1 commit into from
Jun 23, 2022
Merged

[ci][docker] Send a PR to bump the Docker images nightly #11813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/nightly_docker_update.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
schedule:
- cron: "0 0 * * *"
workflow_dispatch:

concurrency:
group: nightly-docker-update
cancel-in-progress: true

jobs:
open_update_pr:
permissions:
actions: write
checks: write
contents: write
id-token: write
issues: write
pull-requests: write
statuses: write
if: github.repository == 'apache/tvm'
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Open PR to update Docker images
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -eux
python tests/scripts/open_docker_update_pr.py
113 changes: 113 additions & 0 deletions tests/python/ci/test_ci.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
keys = list(values[0].keys())
if len(keys) == 1:
return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
def __init__(self, cwd):
self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
)


@parameterize_named(
dict(
tlcpackstaging_body={
"results": [
{
"last_updated": "2022-06-01T00:00:00.123456Z",
"name": "abc-abc-123",
},
]
},
tlcpack_body={
"results": [
{
"last_updated": "2022-06-01T00:00:00.123456Z",
"name": "abc-abc-123",
},
]
},
expected="Tag names were the same, no update needed",
),
dict(
tlcpackstaging_body={
"results": [
{
"last_updated": "2022-06-01T00:00:00.123456Z",
"name": "abc-abc-234",
},
]
},
tlcpack_body={
"results": [
{
"last_updated": "2022-06-01T00:00:00.123456Z",
"name": "abc-abc-123",
},
]
},
expected="Using tlcpackstaging tag on tlcpack",
),
dict(
tlcpackstaging_body={
"results": [
{
"last_updated": "2022-06-01T00:00:00.123456Z",
"name": "abc-abc-123",
},
]
},
tlcpack_body={
"results": [
{
"last_updated": "2022-06-01T00:01:00.123456Z",
"name": "abc-abc-234",
},
]
},
expected="Found newer image, using: tlcpack",
),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
git.run("init")
git.run("config", "user.name", "ci")
git.run("config", "user.email", "email@example.com")
git.run("checkout", "-b", "main")
git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
images = [
"ci_lint",
"ci_gpu",
"ci_cpu",
"ci_wasm",
"ci_i386",
"ci_qemu",
"ci_arm",
"ci_hexagon",
]

docker_data = {}
for image in images:
docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

proc = subprocess.run(
[
str(tag_script),
"--dry-run",
"--testing-docker-data",
json.dumps(docker_data),
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
encoding="utf-8",
cwd=git.cwd,
env={"GITHUB_TOKEN": "1234"},
check=False,
)

if proc.returncode != 0:
raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
"changed_files,name,check,expected_code",
[
Expand Down
11 changes: 8 additions & 3 deletions tests/scripts/git_utils.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
data = data.encode("utf-8")
req.add_header("Content-Length", len(data))

with request.urlopen(req, data) as response:
response = json.loads(response.read())
try:
with request.urlopen(req, data) as response:
response = json.loads(response.read())
except error.HTTPError as e:
logging.info(f"Error response: {e.read().decode()}")
raise e

return response

def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down
188 changes: 188 additions & 0 deletions tests/scripts/open_docker_update_pr.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
"""Returns a function that can be used in place of docker_api"""

def mock(url: str) -> Dict[str, Any]:
if url in data:
return data[url]
else:
raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

return mock


def parse_docker_date(d: str) -> datetime.datetime:
"""Turn a date string from the Docker API into a datetime object"""
return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
"""
Queries Docker Hub and finds the most recent tag for the specified image/repo pair
"""
r = docker_api(f"repositories/{user}/{repo}/tags")
results = r["results"]

for result in results:
result["last_updated"] = parse_docker_date(result["last_updated"])

results = list(sorted(results, key=lambda d: d["last_updated"]))
return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
"""
Finds the latest full tag to use in the Jenkinsfile or returns None if no
update is needed
"""
name, current_tag = source.split(":")
user, repo = name.split("/")
logging.info(
f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
)

staging_repo = repo.replace("-", "_")
latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

if latest_tlcpackstaging_tag["name"] == current_tag:
logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
logging.info("Tag names were the same, no update needed")
return None

if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
else:
# Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
# so hardcode the username here
new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
logging.info("Using tlcpackstaging tag on tlcpack")

logging.info(f"Found newer image, using: {new_spec}")
return new_spec


if __name__ == "__main__":
init_log()
help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
parser = argparse.ArgumentParser(description=help)
parser.add_argument("--remote", default="origin", help="ssh remote to parse")
parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
args = parser.parse_args()

# Install test mock if necessary
if args.testing_docker_data is not None:
docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

remote = git(["config", "--get", f"remote.{args.remote}.url"])
user, repo = parse_remote(remote)

# Read the existing images from the Jenkinsfile
logging.info(f"Reading {JENKINSFILE}")
with open(JENKINSFILE) as f:
content = f.readlines()

# Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
new_content = []
for line in content:
m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
if m is not None:
logging.info(f"Found match on line {line.strip()}")
groups = m.groups()
new_image = latest_tlcpackstaging_image(groups[1])
if new_image is None:
logging.info(f"No new image found")
new_content.append(line)
else:
logging.info(f"Using new image {new_image}")
new_content.append(f"{groups[0]} = '{new_image}'\n")
else:
new_content.append(line)

# Write out the new content
if args.dry_run:
logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
else:
logging.info(f"Writing new content to {JENKINSFILE}")
with open(JENKINSFILE, "w") as f:
f.write("".join(new_content))

# Publish the PR
title = "[ci][docker] Nightly Docker image update"
body = "This bumps the Docker images to the latest versions from Docker Hub."
message = f"{title}\n\n\n{body}"

if args.dry_run:
logging.info("Dry run, would have committed Jenkinsfile")
else:
logging.info(f"Creating git commit")
git(["checkout", "-B", BRANCH])
git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
git(["config", "user.name", "tvm-bot"])
git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
git(["commit", "-m", message])
git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

logging.info(f"Sending PR to GitHub")
github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
data = {
"title": title,
"body": body,
"head": BRANCH,
"base": "main",
"maintainer_can_modify": True,
}
url = "pulls"
if args.dry_run:
logging.info(f"Dry run, would have sent {data} to {url}")
else:
try:
github.post(url, data=data)
except error.HTTPError as e:
# Ignore the exception if the PR already exists (which gives a 422). The
# existing PR will have been updated in place
if e.code == 422:
logging.info("PR already exists, ignoring error")
logging.exception(e)
else:
raise e
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[ci][docker] Send a PR to bump the Docker images nightly#11813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

areusch
merged 1 commit into

from

Jun 23, 2022
 Merged


[ci][docker] Send a PR to bump the Docker images nightly
#11813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 31 additions & 0 deletions
.github/workflows/nightly_docker_update.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@

name: Nightly Docker Update
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:

concurrency:
 group: nightly-docker-update
 cancel-in-progress: true

jobs:
 open_update_pr:
 permissions:
 actions: write
 checks: write
 contents: write
 id-token: write
 issues: write
 pull-requests: write
 statuses: write
 if: github.repository == 'apache/tvm'
 runs-on: ubuntu-20.04
 steps:
 - uses: actions/checkout@v2
 - name: Open PR to update Docker images
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: |
 set -eux
 python tests/scripts/open_docker_update_pr.py

113 changes: 113 additions & 0 deletions
tests/python/ci/test_ci.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@
from test_utils import REPO_ROOT


def parameterize_named(*values):
 keys = list(values[0].keys())
 if len(keys) == 1:
 return pytest.mark.parametrize(",".join(keys), [d[keys[0]] for d in values])

 return pytest.mark.parametrize(",".join(keys), [tuple(d.values()) for d in values])


class TempGit:
 def __init__(self, cwd):
 self.cwd = cwd
Expand DownExpand Up@@ -788,6 +796,111 @@ def run(type, data, check):
 )


@parameterize_named(
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Tag names were the same, no update needed",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 expected="Using tlcpackstaging tag on tlcpack",
 ),
 dict(
 tlcpackstaging_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:00:00.123456Z",
 "name": "abc-abc-123",
 },
 ]
 },
 tlcpack_body={
 "results": [
 {
 "last_updated": "2022-06-01T00:01:00.123456Z",
 "name": "abc-abc-234",
 },
 ]
 },
 expected="Found newer image, using: tlcpack",
 ),
)
def test_open_docker_update_pr(tmpdir_factory, tlcpackstaging_body, tlcpack_body, expected):
 tag_script = REPO_ROOT / "tests" / "scripts" / "open_docker_update_pr.py"

 git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
 git.run("init")
 git.run("config", "user.name", "ci")
 git.run("config", "user.email", "email@example.com")
 git.run("checkout", "-b", "main")
 git.run("remote", "add", "origin", "https://github.com/apache/tvm.git")
 images = [
 "ci_lint",
 "ci_gpu",
 "ci_cpu",
 "ci_wasm",
 "ci_i386",
 "ci_qemu",
 "ci_arm",
 "ci_hexagon",
 ]

 docker_data = {}
 for image in images:
 docker_data[f"repositories/tlcpackstaging/{image}/tags"] = tlcpackstaging_body
 docker_data[f"repositories/tlcpack/{image.replace('_', '-')}/tags"] = tlcpack_body

 proc = subprocess.run(
 [
 str(tag_script),
 "--dry-run",
 "--testing-docker-data",
 json.dumps(docker_data),
 ],
 stdout=subprocess.PIPE,
 stderr=subprocess.STDOUT,
 encoding="utf-8",
 cwd=git.cwd,
 env={"GITHUB_TOKEN": "1234"},
 check=False,
 )

 if proc.returncode != 0:
 raise RuntimeError(f"Process failed:\nstdout:\n{proc.stdout}\n\nstderr:\n{proc.stderr}")

 assert_in(expected, proc.stdout)


@pytest.mark.parametrize(
 "changed_files,name,check,expected_code",
 [
Expand Down

11 changes: 8 additions & 3 deletions
tests/scripts/git_utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
import re
import base64
import logging
from urllib import request
from urllib import request, error
from typing import Dict, Tuple, Any, Optional, List


Expand DownExpand Up@@ -85,8 +85,13 @@ def _request(self, full_url: str, body: Dict[str, Any], method: str) -> Dict[str
 data = data.encode("utf-8")
 req.add_header("Content-Length", len(data))

 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 try:
 with request.urlopen(req, data) as response:
 response = json.loads(response.read())
 except error.HTTPError as e:
 logging.info(f"Error response: {e.read().decode()}")
 raise e

 return response

 def put(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]:
Expand Down

188 changes: 188 additions & 0 deletions
tests/scripts/open_docker_update_pr.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
#!/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 re
import logging
import datetime
import os
import json
from urllib import error
from typing import List, Dict, Any, Optional, Callable
from git_utils import git, parse_remote, GitHubRepo
from cmd_utils import REPO_ROOT, init_log
from should_rebuild_docker import docker_api

JENKINSFILE = REPO_ROOT / "jenkins" / "Jenkinsfile.j2"
GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
BRANCH = "nightly-docker-update"


def _testing_docker_api(data: Dict[str, Any]) -> Callable[[str], Dict[str, Any]]:
 """Returns a function that can be used in place of docker_api"""

 def mock(url: str) -> Dict[str, Any]:
 if url in data:
 return data[url]
 else:
 raise error.HTTPError(url, 404, f"Not found: {url}", {}, None)

 return mock


def parse_docker_date(d: str) -> datetime.datetime:
 """Turn a date string from the Docker API into a datetime object"""
 return datetime.datetime.strptime(d, "%Y-%m-%dT%H:%M:%S.%fZ")


def latest_tag(user: str, repo: str) -> List[Dict[str, Any]]:
 """
 Queries Docker Hub and finds the most recent tag for the specified image/repo pair
 """
 r = docker_api(f"repositories/{user}/{repo}/tags")
 results = r["results"]

 for result in results:
 result["last_updated"] = parse_docker_date(result["last_updated"])

 results = list(sorted(results, key=lambda d: d["last_updated"]))
 return results[-1]


def latest_tlcpackstaging_image(source: str) -> Optional[str]:
 """
 Finds the latest full tag to use in the Jenkinsfile or returns None if no
 update is needed
 """
 name, current_tag = source.split(":")
 user, repo = name.split("/")
 logging.info(
 f"Running with name: {name}, current_tag: {current_tag}, user: {user}, repo: {repo}"
 )

 staging_repo = repo.replace("-", "_")
 latest_tlcpackstaging_tag = latest_tag(user="tlcpackstaging", repo=staging_repo)
 logging.info(f"Found latest tlcpackstaging tag:\n{latest_tlcpackstaging_tag}")

 if latest_tlcpackstaging_tag["name"] == current_tag:
 logging.info(f"tlcpackstaging tag is the same as the one in the Jenkinsfile")

 latest_tlcpack_tag = latest_tag(user="tlcpack", repo=repo)
 logging.info(f"Found latest tlcpack tag:\n{latest_tlcpack_tag}")

 if latest_tlcpack_tag["name"] == latest_tlcpackstaging_tag["name"]:
 logging.info("Tag names were the same, no update needed")
 return None

 if latest_tlcpack_tag["last_updated"] > latest_tlcpackstaging_tag["last_updated"]:
 new_spec = f"tlcpack/{repo}:{latest_tlcpack_tag['name']}"
 else:
 # Even if the image doesn't exist in tlcpack, it will fall back to tlcpackstaging
 # so hardcode the username here
 new_spec = f"tlcpack/{repo}:{latest_tlcpackstaging_tag['name']}"
 logging.info("Using tlcpackstaging tag on tlcpack")

 logging.info(f"Found newer image, using: {new_spec}")
 return new_spec


if __name__ == "__main__":
 init_log()
 help = "Open a PR to update the Docker images to use the latest available in tlcpackstaging"
 parser = argparse.ArgumentParser(description=help)
 parser.add_argument("--remote", default="origin", help="ssh remote to parse")
 parser.add_argument("--dry-run", action="store_true", help="don't send PR to GitHub")
 parser.add_argument("--testing-docker-data", help="JSON data to mock Docker Hub API response")
 args = parser.parse_args()

 # Install test mock if necessary
 if args.testing_docker_data is not None:
 docker_api = _testing_docker_api(data=json.loads(args.testing_docker_data))

 remote = git(["config", "--get", f"remote.{args.remote}.url"])
 user, repo = parse_remote(remote)

 # Read the existing images from the Jenkinsfile
 logging.info(f"Reading {JENKINSFILE}")
 with open(JENKINSFILE) as f:
 content = f.readlines()

 # Build a new Jenkinsfile with the latest images from tlcpack or tlcpackstaging
 new_content = []
 for line in content:
 m = re.match(r"^(ci_[a-zA-Z0-9]+) = \'(.*)\'", line.strip())
 if m is not None:
 logging.info(f"Found match on line {line.strip()}")
 groups = m.groups()
 new_image = latest_tlcpackstaging_image(groups[1])
 if new_image is None:
 logging.info(f"No new image found")
 new_content.append(line)
 else:
 logging.info(f"Using new image {new_image}")
 new_content.append(f"{groups[0]} = '{new_image}'\n")
 else:
 new_content.append(line)

 # Write out the new content
 if args.dry_run:
 logging.info(f"Dry run, would have written new content to {JENKINSFILE}")
 else:
 logging.info(f"Writing new content to {JENKINSFILE}")
 with open(JENKINSFILE, "w") as f:
 f.write("".join(new_content))

 # Publish the PR
 title = "[ci][docker] Nightly Docker image update"
 body = "This bumps the Docker images to the latest versions from Docker Hub."
 message = f"{title}\n\n\n{body}"

 if args.dry_run:
 logging.info("Dry run, would have committed Jenkinsfile")
 else:
 logging.info(f"Creating git commit")
 git(["checkout", "-B", BRANCH])
 git(["add", str(JENKINSFILE.relative_to(REPO_ROOT))])
 git(["config", "user.name", "tvm-bot"])
 git(["config", "user.email", "95660001+tvm-bot@users.noreply.github.com"])
 git(["commit", "-m", message])
 git(["push", "--set-upstream", args.remote, BRANCH, "--force"])

 logging.info(f"Sending PR to GitHub")
 github = GitHubRepo(user=user, repo=repo, token=GITHUB_TOKEN)
 data = {
 "title": title,
 "body": body,
 "head": BRANCH,
 "base": "main",
 "maintainer_can_modify": True,
 }
 url = "pulls"
 if args.dry_run:
 logging.info(f"Dry run, would have sent {data} to {url}")
 else:
 try:
 github.post(url, data=data)
 except error.HTTPError as e:
 # Ignore the exception if the PR already exists (which gives a 422). The
 # existing PR will have been updated in place
 if e.code == 422:
 logging.info("PR already exists, ignoring error")
 logging.exception(e)
 else:
 raise e