mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

build: use afs on aks instead of circle cache (#39881)

Browse source 
* build: use afs on aks instead of circle cache

* build: do not use aks logic on linux hosts checking out for macOS

* build: fix gn-check could-be-aks

* build: sigh

* build: no ls mnt

* build: keep build alive while debugging

* build: make debuggable

---------

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>
This commit is contained in:
Samuel Attard 2023-09-19 03:12:14 -07:00 committed by GitHub
parent 18717ee62d
commit 75ea294b6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 220 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

237
.circleci/config/base.yml
View file

@ -35,6 +35,11 @@ parameters:
default: all default: all
enum: ["all", "osx-x64", "osx-arm64", "mas-x64", "mas-arm64"] enum: ["all", "osx-x64", "osx-arm64", "mas-x64", "mas-arm64"]
medium-linux-executor:
type: enum
default: electronjs/aks-linux-medium
enum: ["electronjs/aks-linux-medium", "medium"]
large-linux-executor: large-linux-executor:
type: enum type: enum
default: electronjs/aks-linux-large default: electronjs/aks-linux-large
@ -49,7 +54,7 @@ executors:
type: enum type: enum
# aks-linux-large === 32 core # aks-linux-large === 32 core
# 2xlarge should not be used directly, use the pipeline param instead # 2xlarge should not be used directly, use the pipeline param instead
enum: ["medium", "xlarge", "electronjs/aks-linux-large", "2xlarge"] enum: ["medium", "electronjs/aks-linux-medium", "xlarge", "electronjs/aks-linux-large", "2xlarge"]
docker: docker:
- image: ghcr.io/electron/build:e6bebd08a51a0d78ec23e5b3fd7e7c0846412328 - image: ghcr.io/electron/build:e6bebd08a51a0d78ec23e5b3fd7e7c0846412328
resource_class: << parameters.size >> resource_class: << parameters.size >>
@ -900,14 +905,26 @@ step-touch-sync-done: &step-touch-sync-done
step-maybe-restore-src-cache: &step-maybe-restore-src-cache step-maybe-restore-src-cache: &step-maybe-restore-src-cache
restore_cache: restore_cache:
keys: keys:
- v16-src-cache-{{ checksum "src/electron/.depshash" }} - v17-src-cache-{{ checksum "src/electron/.depshash" }}
name: Restoring src cache name: Restoring src cache
step-maybe-restore-src-cache-marker: &step-maybe-restore-src-cache-marker step-maybe-restore-src-cache-marker: &step-maybe-restore-src-cache-marker
restore_cache: restore_cache:
keys: keys:
- v16-src-cache-marker-{{ checksum "src/electron/.depshash" }} - v17-src-cache-marker-{{ checksum "src/electron/.depshash" }}
name: Restoring src cache marker name: Restoring src cache marker
step-maybe-restore-src-cache-aks: &step-maybe-restore-src-cache-aks
restore_cache_aks:
step-name: Restoring src cache
cache_key: v17-src-cache-$(shasum src/electron/.depshash | cut -f1 -d' ')
cache_path: /var/portal
step-maybe-restore-src-cache-marker-aks: &step-maybe-restore-src-cache-marker-aks
restore_cache_aks:
step-name: Restoring src cache marker
cache_key: v17-src-cache-marker-$(shasum src/electron/.depshash | cut -f1 -d' ')
cache_path: "."
# Restore exact or closest git cache based on the hash of DEPS and .circle-sync-done # Restore exact or closest git cache based on the hash of DEPS and .circle-sync-done
# If the src cache was restored above then this will match an empty cache # If the src cache was restored above then this will match an empty cache
# If the src cache was not restored above then this will match a close git cache # If the src cache was not restored above then this will match a close git cache
@ -920,6 +937,12 @@ step-maybe-restore-git-cache: &step-maybe-restore-git-cache
- v1-git-cache-{{ checksum "src/electron/.circle-sync-done" }} - v1-git-cache-{{ checksum "src/electron/.circle-sync-done" }}
name: Conditionally restoring git cache name: Conditionally restoring git cache
step-maybe-restore-git-cache-aks: &step-maybe-restore-git-cache-aks
restore_cache_aks:
step-name: Conditionally restoring git cache (aks)
cache_key: v1-git-cache-$(shasum src/electron/.circle-sync-done | cut -f1 -d' ')-$(shasum src/electron/DEPS | cut -f1 -d' ') v1-git-cache-$(shasum src/electron/.circle-sync-done | cut -f1 -d' ')
cache_path: git-cache
step-set-git-cache-path: &step-set-git-cache-path step-set-git-cache-path: &step-set-git-cache-path
run: run:
name: Set GIT_CACHE_PATH to make gclient to use the cache name: Set GIT_CACHE_PATH to make gclient to use the cache
@ -937,6 +960,12 @@ step-save-git-cache: &step-save-git-cache
key: v1-git-cache-{{ checksum "src/electron/.circle-sync-done" }}-{{ checksum "src/electron/DEPS" }} key: v1-git-cache-{{ checksum "src/electron/.circle-sync-done" }}-{{ checksum "src/electron/DEPS" }}
name: Persisting git cache name: Persisting git cache
step-save-git-cache-aks: &step-save-git-cache-aks
save_cache_aks:
step-name: Persisting git cache (AKS)
cache_key: v1-git-cache-$(shasum src/electron/.circle-sync-done | cut -f1 -d' ')-$(shasum src/electron/DEPS | cut -f1 -d' ')
cache_path: git-cache
step-run-electron-only-hooks: &step-run-electron-only-hooks step-run-electron-only-hooks: &step-run-electron-only-hooks
run: run:
name: Run Electron Only Hooks name: Run Electron Only Hooks
@ -974,7 +1003,7 @@ step-save-src-cache: &step-save-src-cache
save_cache: save_cache:
paths: paths:
- /var/portal - /var/portal
key: v16-src-cache-{{ checksum "/var/portal/src/electron/.depshash" }} key: v17-src-cache-{{ checksum "/var/portal/src/electron/.depshash" }}
name: Persisting src cache name: Persisting src cache
step-make-src-cache-marker: &step-make-src-cache-marker step-make-src-cache-marker: &step-make-src-cache-marker
run: run:
@ -984,7 +1013,17 @@ step-save-src-cache-marker: &step-save-src-cache-marker
save_cache: save_cache:
paths: paths:
- .src-cache-marker - .src-cache-marker
key: v16-src-cache-marker-{{ checksum "/var/portal/src/electron/.depshash" }} key: v17-src-cache-marker-{{ checksum "/var/portal/src/electron/.depshash" }}
step-save-src-cache-aks: &step-save-src-cache-aks
save_cache_aks:
step-name: Persisting src cache (aks)
cache_key: v17-src-cache-$(shasum /var/portal/src/electron/.depshash | cut -f1 -d' ')
cache_path: /var/portal
step-save-src-cache-marker-aks: &step-save-src-cache-marker-aks
save_cache_aks:
step-name: Persisting src cache marker (aks)
cache_key: v17-src-cache-marker-$(shasum /var/portal/src/electron/.depshash | cut -f1 -d' ')
cache_path: .src-cache-marker
step-maybe-early-exit-no-doc-change: &step-maybe-early-exit-no-doc-change step-maybe-early-exit-no-doc-change: &step-maybe-early-exit-no-doc-change
run: run:
@ -1010,15 +1049,6 @@ step-ts-compile: &step-ts-compile
done done
# List of all steps. # List of all steps.
steps-electron-gn-check: &steps-electron-gn-check
steps:
- *step-setup-goma-for-build
- checkout-from-cache
- *step-setup-env-for-build
- *step-wait-for-goma
- *step-gn-gen-default
- *step-gn-check
steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-change steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-change
steps: steps:
# Checkout - Copied from steps-checkout # Checkout - Copied from steps-checkout
@ -1030,11 +1060,92 @@ steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-cha
# Command Aliases # Command Aliases
commands: commands:
aks-specific-step:
parameters:
circle:
type: steps
aks:
type: steps
could-be-aks:
type: boolean
description: Only set this to true on linux hosts
steps:
- when:
condition:
or:
- equal: [<< parameters.could-be-aks >>, false]
- equal: [<< pipeline.parameters.large-linux-executor >>, xlarge]
steps: << parameters.circle >>
- when:
condition:
and:
- equal: [<< parameters.could-be-aks >>, true]
- equal: [<< pipeline.parameters.large-linux-executor >>, electronjs/aks-linux-large]
steps: << parameters.aks >>
save_cache_aks:
parameters:
step-name:
type: string
cache_key:
type: string
cache_path:
type: string
steps:
- run:
name: << parameters.step-name >>
command: |
cache_key="<< parameters.cache_key >>"
final_cache_path=/mnt/cross-instance-cache/${cache_key}.tar
echo "Using cache key: $cache_key"
echo "Checking path: $final_cache_path"
if [ ! -f "$final_cache_path" ]; then
echo "Cache key not founding, storing tarball"
tmp_container=/mnt/cross-instance-cache/tmp/$CIRCLE_WORKFLOW_JOB_ID
tmp_cache_path=$tmp_container/${cache_key}.tar
mkdir -p $tmp_container
if [ -f "<< parameters.cache_path >>" ]; then
tar -cf $tmp_cache_path -C $(dirname << parameters.cache_path >>) ./$(basename << parameters.cache_path >>)
else
tar -cf $tmp_cache_path -C << parameters.cache_path >>/ ./
fi
mv -vn $tmp_cache_path $final_cache_path
rm -rf $tmp_container
else
echo "Cache key already exists, skipping.."
fi
restore_cache_aks:
parameters:
step-name:
type: string
cache_key:
type: string
cache_path:
type: string
steps:
- run:
name: << parameters.step-name >>
command: |
df -h
for cache_key in << parameters.cache_key >>; do
cache_path=/mnt/cross-instance-cache/${cache_key}.tar
echo "Using cache key: $cache_key"
echo "Checking path: $cache_path"
if [ ! -f "$cache_path" ]; then
echo "Cache key not found, nothing to restore..."
else
echo "Cache key found, restoring to path..."
mkdir -p << parameters.cache_path >>/
tar -xf /mnt/cross-instance-cache/${cache_key}.tar -C << parameters.cache_path >>/
exit 0
fi
done
maybe-restore-portaled-src-cache: maybe-restore-portaled-src-cache:
parameters: parameters:
halt-if-successful: halt-if-successful:
type: boolean type: boolean
default: false default: false
could-be-aks:
type: boolean
steps: steps:
- run: - run:
name: Prepare for cross-OS sync restore name: Prepare for cross-OS sync restore
@ -1044,23 +1155,44 @@ commands:
- when: - when:
condition: << parameters.halt-if-successful >> condition: << parameters.halt-if-successful >>
steps: steps:
- aks-specific-step:
circle:
- *step-maybe-restore-src-cache-marker - *step-maybe-restore-src-cache-marker
aks:
- *step-maybe-restore-src-cache-marker-aks
could-be-aks: << parameters.could-be-aks >>
- run: - run:
name: Halt the job early if the src cache exists name: Halt the job early if the src cache exists
command: | command: |
if [ -f ".src-cache-marker" ]; then if [ -f ".src-cache-marker" ]; then
circleci-agent step halt circleci-agent step halt
fi fi
- aks-specific-step:
circle:
- *step-maybe-restore-src-cache - *step-maybe-restore-src-cache
aks:
- *step-maybe-restore-src-cache-aks
could-be-aks: << parameters.could-be-aks >>
- run: - run:
name: Fix the src cache restore point on macOS name: Fix the src cache restore point
command: | command: |
if [ -d "/var/portal/src" ]; then if [ -d "/var/portal/src" ]; then
echo Relocating Cache echo Relocating Cache
rm -rf src rm -rf src
mv /var/portal/src ./ mv /var/portal/src ./
fi fi
run-gn-check:
parameters:
could-be-aks:
type: boolean
steps:
- *step-setup-goma-for-build
- checkout-from-cache:
could-be-aks: << parameters.could-be-aks >>
- *step-setup-env-for-build
- *step-wait-for-goma
- *step-gn-gen-default
- *step-gn-check
build_and_save_artifacts: build_and_save_artifacts:
parameters: parameters:
artifact-key: artifact-key:
@ -1174,12 +1306,16 @@ commands:
mv_if_exist cross-arch-snapshots src mv_if_exist cross-arch-snapshots src
checkout-from-cache: checkout-from-cache:
parameters:
could-be-aks:
type: boolean
steps: steps:
- *step-checkout-electron - *step-checkout-electron
- *step-depot-tools-get - *step-depot-tools-get
- *step-depot-tools-add-to-path - *step-depot-tools-add-to-path
- *step-generate-deps-hash - *step-generate-deps-hash
- maybe-restore-portaled-src-cache - maybe-restore-portaled-src-cache:
could-be-aks: << parameters.could-be-aks >>
- run: - run:
name: Ensure src checkout worked name: Ensure src checkout worked
command: | command: |
@ -1291,6 +1427,8 @@ commands:
after-persist: after-persist:
type: steps type: steps
default: [] default: []
could-be-aks:
type: boolean
steps: steps:
- when: - when:
condition: << parameters.attach >> condition: << parameters.attach >>
@ -1308,7 +1446,8 @@ commands:
- when: - when:
condition: << parameters.checkout-and-assume-cache >> condition: << parameters.checkout-and-assume-cache >>
steps: steps:
- checkout-from-cache - checkout-from-cache:
could-be-aks: << parameters.could-be-aks >>
- when: - when:
condition: << parameters.checkout >> condition: << parameters.checkout >>
steps: steps:
@ -1324,8 +1463,15 @@ commands:
steps: steps:
- maybe-restore-portaled-src-cache: - maybe-restore-portaled-src-cache:
halt-if-successful: << parameters.checkout-to-create-src-cache >> halt-if-successful: << parameters.checkout-to-create-src-cache >>
could-be-aks: << parameters.could-be-aks >>
- aks-specific-step:
circle:
- *step-maybe-restore-git-cache - *step-maybe-restore-git-cache
aks:
- *step-maybe-restore-git-cache-aks
could-be-aks: << parameters.could-be-aks >>
- *step-set-git-cache-path - *step-set-git-cache-path
- *step-fix-known-hosts-linux
# This sync call only runs if .circle-sync-done is an EMPTY file # This sync call only runs if .circle-sync-done is an EMPTY file
- *step-gclient-sync - *step-gclient-sync
- store_artifacts: - store_artifacts:
@ -1341,7 +1487,12 @@ commands:
- when: - when:
condition: << parameters.save-git-cache >> condition: << parameters.save-git-cache >>
steps: steps:
- aks-specific-step:
circle:
- *step-save-git-cache - *step-save-git-cache
aks:
- *step-save-git-cache-aks
could-be-aks: << parameters.could-be-aks >>
# Mark sync as done _after_ saving the git cache so that it is uploaded # Mark sync as done _after_ saving the git cache so that it is uploaded
# only when the src cache was not present # only when the src cache was not present
# Their are theoretically two cases for this cache key # Their are theoretically two cases for this cache key
@ -1391,9 +1542,19 @@ commands:
sudo mkdir -p /var/portal sudo mkdir -p /var/portal
sudo chown -R $(id -u):$(id -g) /var/portal sudo chown -R $(id -u):$(id -g) /var/portal
mv ./src /var/portal mv ./src /var/portal
- aks-specific-step:
circle:
- *step-save-src-cache - *step-save-src-cache
aks:
- *step-save-src-cache-aks
could-be-aks: << parameters.could-be-aks >>
- *step-make-src-cache-marker - *step-make-src-cache-marker
- aks-specific-step:
circle:
- *step-save-src-cache-marker - *step-save-src-cache-marker
aks:
- *step-save-src-cache-marker-aks
could-be-aks: << parameters.could-be-aks >>
- when: - when:
condition: << parameters.build >> condition: << parameters.build >>
@ -1447,6 +1608,18 @@ commands:
condition: << parameters.build >> condition: << parameters.build >>
steps: steps:
- *step-maybe-notify-slack-failure - *step-maybe-notify-slack-failure
- when:
condition: << parameters.could-be-aks >>
steps:
- run:
name: Wait for active debug sessions
command: |
while [ -f /var/.ssh-lock ]
do
sleep 60
done
no_output_timeout: 2h
when: always
electron-tests: electron-tests:
parameters: parameters:
@ -1633,7 +1806,7 @@ jobs:
linux-make-src-cache: linux-make-src-cache:
executor: executor:
name: linux-docker name: linux-docker
size: xlarge size: << pipeline.parameters.large-linux-executor >>
environment: environment:
<<: *env-linux-2xlarge <<: *env-linux-2xlarge
GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True' GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
@ -1646,6 +1819,7 @@ jobs:
checkout-to-create-src-cache: true checkout-to-create-src-cache: true
artifact-key: 'nil' artifact-key: 'nil'
build-type: 'nil' build-type: 'nil'
could-be-aks: true
mac-checkout: mac-checkout:
executor: executor:
@ -1665,6 +1839,7 @@ jobs:
restore-src-cache: false restore-src-cache: false
artifact-key: 'nil' artifact-key: 'nil'
build-type: 'nil' build-type: 'nil'
could-be-aks: false
mac-make-src-cache-x64: mac-make-src-cache-x64:
executor: executor:
@ -1684,6 +1859,7 @@ jobs:
checkout-to-create-src-cache: true checkout-to-create-src-cache: true
artifact-key: 'nil' artifact-key: 'nil'
build-type: 'nil' build-type: 'nil'
could-be-aks: false
mac-make-src-cache-arm64: mac-make-src-cache-arm64:
executor: executor:
@ -1703,6 +1879,7 @@ jobs:
checkout-to-create-src-cache: true checkout-to-create-src-cache: true
artifact-key: 'nil' artifact-key: 'nil'
build-type: 'nil' build-type: 'nil'
could-be-aks: false
# Layer 2: Builds. # Layer 2: Builds.
linux-x64-testing: linux-x64-testing:
@ -1721,6 +1898,7 @@ jobs:
checkout-and-assume-cache: true checkout-and-assume-cache: true
artifact-key: 'linux-x64' artifact-key: 'linux-x64'
build-type: 'Linux' build-type: 'Linux'
could-be-aks: true
linux-x64-testing-asan: linux-x64-testing-asan:
executor: executor:
@ -1740,16 +1918,19 @@ jobs:
build-nonproprietary-ffmpeg: false build-nonproprietary-ffmpeg: false
artifact-key: 'linux-x64-asan' artifact-key: 'linux-x64-asan'
build-type: 'Linux' build-type: 'Linux'
could-be-aks: true
linux-x64-testing-gn-check: linux-x64-testing-gn-check:
executor: executor:
name: linux-docker name: linux-docker
size: medium size: << pipeline.parameters.medium-linux-executor >>
environment: environment:
<<: *env-linux-medium <<: *env-linux-medium
<<: *env-testing-build <<: *env-testing-build
GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True' GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
<<: *steps-electron-gn-check steps:
- run-gn-check:
could-be-aks: true
linux-x64-publish: linux-x64-publish:
executor: executor:
@ -1793,6 +1974,7 @@ jobs:
checkout-and-assume-cache: true checkout-and-assume-cache: true
artifact-key: 'linux-arm' artifact-key: 'linux-arm'
build-type: 'Linux ARM' build-type: 'Linux ARM'
could-be-aks: true
linux-arm-publish: linux-arm-publish:
executor: executor:
@ -1838,17 +2020,20 @@ jobs:
checkout-and-assume-cache: true checkout-and-assume-cache: true
artifact-key: 'linux-arm64' artifact-key: 'linux-arm64'
build-type: 'Linux ARM64' build-type: 'Linux ARM64'
could-be-aks: true
linux-arm64-testing-gn-check: linux-arm64-testing-gn-check:
executor: executor:
name: linux-docker name: linux-docker
size: medium size: << pipeline.parameters.medium-linux-executor >>
environment: environment:
<<: *env-linux-medium <<: *env-linux-medium
<<: *env-arm64 <<: *env-arm64
<<: *env-testing-build <<: *env-testing-build
GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True' GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
<<: *steps-electron-gn-check steps:
- run-gn-check:
could-be-aks: true
linux-arm64-publish: linux-arm64-publish:
executor: executor:
@ -1908,6 +2093,7 @@ jobs:
root: . root: .
paths: paths:
- generated_artifacts_mas-x64 - generated_artifacts_mas-x64
could-be-aks: false
osx-testing-x64-gn-check: osx-testing-x64-gn-check:
executor: executor:
@ -1917,7 +2103,9 @@ jobs:
<<: *env-machine-mac <<: *env-machine-mac
<<: *env-testing-build <<: *env-testing-build
GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac' GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac'
<<: *steps-electron-gn-check steps:
- run-gn-check:
could-be-aks: false
osx-publish-x64: osx-publish-x64:
executor: executor:
@ -1999,6 +2187,7 @@ jobs:
root: . root: .
paths: paths:
- generated_artifacts_mas-arm64 - generated_artifacts_mas-arm64
could-be-aks: false
mas-publish-x64: mas-publish-x64:
executor: executor:

1
.circleci/config/params.js
View file

@ -7,5 +7,6 @@ const content = JSON.parse(fs.readFileSync(PARAMS_PATH, 'utf-8'));
// Choose resource class for linux hosts // Choose resource class for linux hosts
const currentBranch = process.env.CIRCLE_BRANCH || ''; const currentBranch = process.env.CIRCLE_BRANCH || '';
content['large-linux-executor'] = /^pull\/[0-9-]+$/.test(currentBranch) ? '2xlarge' : 'electronjs/aks-linux-large'; content['large-linux-executor'] = /^pull\/[0-9-]+$/.test(currentBranch) ? '2xlarge' : 'electronjs/aks-linux-large';
content['medium-linux-executor'] = /^pull\/[0-9-]+$/.test(currentBranch) ? 'medium' : 'electronjs/aks-linux-medium';
fs.writeFileSync(PARAMS_PATH, JSON.stringify(content)); fs.writeFileSync(PARAMS_PATH, JSON.stringify(content));