Skip to content

Try using Kaleido v1 for image tests #7412

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.

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

Draft
wants to merge 25 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9a078e3
try using Kaleido v1 for image tests
emilykl Apr 30, 2025
f7f5a03
Update Plotly version
emilykl May 2, 2025
5595393
Merge branch 'master' into use-new-kaleido-for-image-tests
emilykl May 27, 2025
afafaf2
update version
emilykl May 27, 2025
8c84e4b
update to new pio API and use unreleased Plotly and Kaleido
emilykl May 29, 2025
14298d8
typo
emilykl May 29, 2025
09a0f4f
install chrome for make-baselines jobs
emilykl May 29, 2025
94335b8
add apt-get update step
emilykl May 29, 2025
86f0a3e
does it work with '-browsers' images?
emilykl May 29, 2025
30c39f4
use cimg instead of circleci
emilykl May 30, 2025
279af99
use python instead of python3
emilykl May 30, 2025
ecb2c0c
Revert "use python instead of python3"
emilykl May 30, 2025
97b5f29
ensurepip
emilykl May 30, 2025
18f0a67
Revert "ensurepip"
emilykl May 30, 2025
3f13771
'python' rather than 'sudo python3'
emilykl May 30, 2025
fae9f08
try python3 without sudo
emilykl May 30, 2025
d0fa346
pip install requests
emilykl May 30, 2025
03a53b6
update kaleido ref
emilykl May 30, 2025
99eb4b5
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
emilykl May 30, 2025
fcafd40
temporarily blacklist 'mathjax' baseline
emilykl May 30, 2025
41172b3
temporarily blacklist 'map_predefined-styles2' baseline
emilykl May 30, 2025
0ec3ba1
remove eps from make_exports
emilykl May 30, 2025
ff45414
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
emilykl May 30, 2025
340fd9e
temporarily blacklist 'map_fonts-supported-metropolis' baseline
emilykl May 30, 2025
4e518a2
typo
emilykl May 30, 2025
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
40 changes: 35 additions & 5 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,15 @@ jobs:
make-baselines-virtual-webgl:
parallelism: 8
docker:
- image: circleci/python:3.8.9
- image: cimg/python:3.8.9-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run:
Expand All @@ -235,9 +241,15 @@ jobs:

make-baselines-mathjax3:
docker:
- image: circleci/python:3.8.9
- image: cimg/python:3.8.9-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run:
Expand All @@ -254,9 +266,15 @@ jobs:
make-baselines:
parallelism: 12
docker:
- image: circleci/python:3.8.9
- image: cimg/python:3.8.9-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run:
Expand All @@ -273,9 +291,15 @@ jobs:
make-baselines-b64:
parallelism: 12
docker:
- image: circleci/python:3.8.9
- image: cimg/python:3.8.9-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run:
Expand Down Expand Up @@ -347,9 +371,15 @@ jobs:

make-exports:
docker:
- image: circleci/python:3.8.9
- image: cimg/python:3.8.9-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run:
Expand Down
12 changes: 9 additions & 3 deletions .circleci/env_image.sh
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji
sudo python3 .circleci/download_google_fonts.py
python3 -m pip install requests --progress-bar off
python3 .circleci/download_google_fonts.py
sudo cp -r .circleci/fonts/ /usr/share/
sudo fc-cache -f
# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==5.5.0 --progress-bar off
# python -m pip install "plotly[kaleido]==6.1.2" --progress-bar off
# Once new Kaleido and Plotly versions are released, uncomment the line above, update the Plotly version,
# and delete the two lines below.
python3 -m pip install "git+https://github.com/plotly/plotly.py.git@6837831" --progress-bar off
python3 -m pip install "git+https://github.com/plotly/[email protected]#subdirectory=src/py" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
13 changes: 10 additions & 3 deletions test/image/make_baseline.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
args = args[args.index('=') + 1:]
Expand All @@ -35,7 +35,7 @@
# until https://github.com/plotly/Kaleido/issues/124 is addressed
# we are uanble to use local mathjax v3 installed in node_modules
# for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-svg.js'
pio.defaults.mathjax = 'https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-svg.js'
mathjax_version = 3
print('Kaleido using MathJax v3')

Expand All @@ -52,7 +52,8 @@

plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.defaults.plotlyjs = plotlyjs

pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All @@ -66,6 +67,12 @@
# unable to generate baselines for the following mocks
blacklist = [
'map_stamen-style',
'gl3d_streamtube_reversed_ranges', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_predefined-styles2', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'mathjax', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_fonts-supported-metropolis' # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand Down
4 changes: 2 additions & 2 deletions test/image/make_exports.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
pio.templates.default = 'none'
pio.kaleido.scope.plotlyjs = os.path.join(root, 'build', 'plotly.js')

allFormats = ['svg', 'jpg', 'jpeg', 'webp', 'eps', 'pdf']
allFormats = ['svg', 'jpg', 'jpeg', 'webp', 'pdf']
# 'png' is tested by image-test

allNames = [
Expand All @@ -28,7 +28,7 @@
'zsmooth_methods',
'fonts',
'worldcup',
'mathjax'
# 'mathjax' # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]

failed = 0
Expand Down