-
Notifications
You must be signed in to change notification settings - Fork 37
296 lines (291 loc) · 17 KB
/
test.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# TODO the next great simplification might be deploying multiple examples to one dfx replica instance: https://forum.dfinity.org/t/use-the-same-local-replica-for-multiple-projects/11900
# TODO this might allow us to avoid spinning up so many jobs in the matrix
# This GitHub Action flow works as follows:
# The tests are currently simple example-based integration tests.
# Each directory in the examples directory represents an example project and is intended to have tests that ensure the canisters contained in that example function properly.
# These tests are currently written in TypeScript and are intended to be run in a Node.js environment.
# This GitHub Action takes care of deploying to npm and GitHub.
# Tests can either run against the current code of Azle found in the repository, or the code deployed by the GitHub Action to npm.
# Feature branch pull requests (pull requests without release-- in the base branch name) will run all tests against the code found in the repository.
# Release branch pull requests (pull requests with release-- in the base branch name) will run all tests against the code found in the repository and the code deployed by the GitHub Action to npm.
# Pushes to main will run all tests against the code in the repository if the latest commit was not a merge of a release branch, and will run tests against the code in the repository and the code deployed by the GitHub Action to npm otherwise.
# The basic-integration-tests matrix spins up one job per combination of example directory and code source (repo or npm).
# The check-basic-integration-tests-success job is designed to ensure that all jobs spun up from the matrix in the basic-integration-tests have succeeded
name: Azle Tests
on:
push:
branches:
- main
pull_request: # Runs on pull requests to any branch
jobs:
generate-tests:
runs-on: ubuntu-latest
outputs:
all_tests: ${{ steps.get_all_tests.outputs.all_tests }}
count: ${{steps.get_all_tests.outputs.count}}
dummy: '[1, 2, 3]'
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run test script and capture output
id: get_all_tests
run: |
# Run the script and capture its output
echo "We are about to get the output"
GREET=$(./scripts/simple.sh)
ALL_TESTS=$(./scripts/test.sh | base64 -d)
ALL_TESTS="${ALL_TESTS//'%'/'%25'}"
ALL_TESTS="${ALL_TESTS//$'\n'/'%0A'}"
ALL_TESTS="${ALL_TESTS//$'\r'/'%0D'}"
COUNT=(0 1 2 3)
echo "all_tests=$ALL_TESTS" >> $GITHUB_ENV
echo "greet=$GREET" >> $GITHUB_ENV
echo "::set-output name=all_tests::$ALL_TESTS"
COUNT_STR=$(IFS=' '; echo "${COUNT[*]}")
COUNT_STR="${COUNT_STR//'%'/'%25'}"
COUNT_STR="${COUNT_STR//$'\n'/'%0A'}"
COUNT_STR="[${COUNT_STR//$'\r'/'%0D'}]"
echo "::set-output name=count::$COUNT_STR"
- name: Print the captured output
run: |
echo "${{ steps.get_all_tests.outputs.all_tests }}" | tail
echo "${{steps.get_all_tests.outputs.count}}"
echo "${{ env.all_tests }}" | tail
echo "${{ env.greet }}"
more-debugging:
runs-on: ubuntu-latest
needs: generate-tests
strategy:
fail-fast: false # We want to see which example tests succeed and which ones fail, we don't want one example test to cancel the rest
matrix:
tests: ${{ fromJSON(needs.generate-tests.outputs.count) || fromJSON('["dummy"]') }}
steps:
- name: Echo test
id: echo-test
run: echo "${{ matrix.tests }}"
dummy-debugging:
runs-on: ubuntu-latest
needs: generate-tests
strategy:
fail-fast: false # We want to see which example tests succeed and which ones fail, we don't want one example test to cancel the rest
matrix:
tests: ${{ fromJSON(needs.generate-tests.outputs.dummy) || fromJSON('["dummy"]') }}
steps:
- name: Echo test
id: echo-test
run: echo "${{ matrix.tests }}"
debug-generate-tests:
name: ${{matrix.tests}}
needs: generate-tests
runs-on: ubuntu-latests
strategy:
fail-fast: false # We want to see which example tests succeed and which ones fail, we don't want one example test to cancel the rest
matrix:
tests: ${{ fromJSON(needs.generate-tests.outputs.all_tests) || fromJSON('["dummy"]') }}
steps:
- name: Echo test
id: echo-test
run: echo "${{ matrix.tests }}"
- name: Echo test path
id: echo-test-path
run: echo "${{ matrix.tests.path }}"
- name: Echo test name
id: echo-test-name
run: echo "${{ matrix.tests.name }}"
test-path-generate:
runs-on: ubuntu-latest
outputs:
example_directories: ${{ steps.example_directories.outputs.example_directories }}
steps:
- uses: actions/checkout@v4
- id: example_directories
name: generateTests
run: |
EXAMPLE_DIRECTORIES=$(./scripts/test.sh | base64 -d)
echo "::set-output name=example_directories::$EXAMPLE_DIRECTORIES"
echo here is the new example dirs
echo $EXAMPLE_DIRECTORIES
- name: Print the captured output
run: echo "${{ steps.example_directories.outputs.example_directories }}"
test-path-debugging:
name: ${{matrix.tests.name}} / ${{matrix.tests.type}} / ${{matrix.tests.syntax}} / ${{matrix.tests.api}}
runs-on: ubuntu-latest
needs: test-path-generate
strategy:
fail-fast: false # We want to see which example tests succeed and which ones fail, we don't want one example test to cancel the rest
matrix:
tests: ${{ fromJSON(needs.test-path-generate.outputs.example_directories) || fromJSON('["dummy"]') }}
steps:
- name: Echo test
id: echo-test
run: echo "${{ matrix.tests.path }}"
release-candidate-deploy:
runs-on: ubuntu-latest
env:
GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }} # All commits must be verified
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
outputs:
# These outputs are used to pass information along to the next job
should_run_tests: ${{ steps.should_run_tests.outputs.should_run_tests }} # We only want the next job to run the tests once we have finished deploying to npm and GitHub
example_directories: ${{ steps.example_directories.outputs.example_directories }}
steps:
- uses: actions/checkout@v4
# if: contains(github.head_ref, 'release--')
with:
ref: ${{ contains(github.head_ref, 'release--') && github.event.pull_request.head.ref || github.ref }} # This is necessary for this job to be able to commit and push to the origin remote properly
token: ${{ secrets.LASTMJS_GITHUB_TOKEN || github.token }} # A personal GitHub token is setup as a secret so that committing and pushing to GitHub from the Action will trigger another workflow
- uses: actions/setup-node@v4
with:
node-version: 20
registry-url: https://registry.npmjs.org
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- if: contains(github.head_ref, 'release--')
name: Install dfx
run: |
DFXVM_INIT_YES=true DFX_VERSION=0.21.0 sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"
echo "$HOME/.local/share/dfx/bin" >> $GITHUB_PATH
# TODO we should use some Action-specific bot account
- if: contains(github.head_ref, 'release--')
run: git config --global user.name 'Jordan Last'
- if: contains(github.head_ref, 'release--')
run: git config --global user.email '[email protected]'
- if: contains(github.head_ref, 'release--')
run: git config --global commit.gpgsign true
- if: contains(github.head_ref, 'release--')
run: echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import
- if: contains(github.head_ref, 'release--')
run: git config --global user.signingkey C8B77BCBE16CD2B94B43F9C8757397B82D4ED7B0
- id: example_directories
# TODO to improve this further we might be able to create an environment variable that grabs the example directories with a glob
# TODO we want to be able to easily include and exclude examples though
# TODO we have a number of flaky tests and we have moved them to the top of the list here so we can keep a better eye on them until we have resolved their flakyness
run: |
EXAMPLE_DIRECTORIES=$(cat << END
[
"examples/hello_world",
"examples/hello_world2"
]
END
)
EXAMPLE_DIRECTORIES="${EXAMPLE_DIRECTORIES//'%'/'%25'}"
EXAMPLE_DIRECTORIES="${EXAMPLE_DIRECTORIES//$'\n'/'%0A'}"
EXAMPLE_DIRECTORIES="${EXAMPLE_DIRECTORIES//$'\r'/'%0D'}"
echo "::set-output name=example_directories::$EXAMPLE_DIRECTORIES"
echo "Here it is the same"
echo $EXAMPLE_DIRECTORIES
echo "Here is the example dirs differently too"
echo "${{ steps.example_directories.outputs.example_directories }}"
- name: Print the captured output
run: echo "${{ steps.example_directories.outputs.example_directories }}"
- id: should_run_tests
run: |
BRANCH_NAME="${{ github.head_ref }}"
RELEASE_VERSION="${BRANCH_NAME:9}"
COMMIT_MESSAGE=$(git log -1 --pretty=format:"%s")
if [[ "${{ contains(github.head_ref, 'release--') }}" == "true" && "$COMMIT_MESSAGE" != "azle-bot automated release $RELEASE_VERSION" ]]
then
./publish-github-action.sh $RELEASE_VERSION ${{ toJSON(steps.example_directories.outputs.example_directories) }}
else
echo "::set-output name=should_run_tests::true"
fi
basic-integration-tests:
name: ${{matrix.example_directories}} from ${{matrix.azle_source}}
needs: release-candidate-deploy
runs-on: ${{ matrix.os }}
env:
ETHEREUM_URL: ${{ secrets.ETHEREUM_URL }}
AZLE_IDENTITY_STORAGE_MODE: 'plaintext'
AZLE_END_TO_END_TEST_LINK_AZLE: ${{ matrix.azle_source == 'repo' }}
AZLE_TEST_RUN_ON_RELEASE: ${{ contains(github.head_ref, 'release--') }}
strategy:
fail-fast: false # We want to see which example tests succeed and which ones fail, we don't want one example test to cancel the rest
matrix:
# os: [macos-latest]
os: [ubuntu-latest]
include_npm:
# Only include npm in the matrix if you've pushed to main and the last commit was a merge of a release branch, or the base branch of the pull request is a release branch
- ${{ (github.ref == 'refs/heads/main' && contains(github.event.head_commit.message, 'Merge pull request') && contains(github.event.head_commit.message, 'demergent-labs/release--')) || contains(github.head_ref, 'release--') }}
azle_source:
- npm
- repo
exclude:
- include_npm: false
azle_source: npm
- include_npm: true
azle_source: repo
# If should_run_tests is false, we still want the steps of this job to execute so that check-basic-integration-tests-success will run. We do this by creating an array with one dummy element
example_directories: ${{ needs.release-candidate-deploy.outputs.should_run_tests == 'true' && fromJSON(needs.release-candidate-deploy.outputs.example_directories) || fromJSON('["dummy"]') }}
steps:
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
name: Echo test name
id: echo-test-name
run: echo "${{ matrix.example_directories }}"
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
name: Set test name
id: set-test-name
run: |
echo "TEST_NAME=$(basename ${{ matrix.example_directories }})" >> $GITHUB_ENV
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
uses: actions/checkout@v4
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
uses: actions/setup-node@v4
with:
node-version: 20
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
name: Install dfx
run: |
DFXVM_INIT_YES=true DFX_VERSION=0.21.0 sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"
echo "$HOME/.local/share/dfx/bin" >> $GITHUB_PATH
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && matrix.os == 'macos-latest' }}
shell: bash -l {0}
# The DNS server stuff is because of this: https://github.com/actions/runner-images/issues/6383
run: |
sudo networksetup -setdnsservers Ethernet 9.9.9.9
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
shell: bash -l {0} # TODO figure out why this is here and comment about it
run: npm install
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && matrix.azle_source == 'repo' }}
shell: bash -l {0}
run: npm link
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
shell: bash -l {0}
run: npm run lint
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
shell: bash -l {0}
working-directory: ${{ matrix.example_directories }}
run: npm install
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && matrix.azle_source == 'repo' }}
shell: bash -l {0}
working-directory: ${{ matrix.example_directories }}
run: npm link azle
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
working-directory: ${{ matrix.example_directories }}
run: npx azle install-dfx-extension
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
working-directory: ${{ matrix.example_directories }}
run: dfx start --clean --background --host 127.0.0.1:8000
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && !contains(github.head_ref, 'release--') && !(github.ref == 'refs/heads/main' && contains(github.event.head_commit.message, 'Merge pull request') && contains(github.event.head_commit.message, 'demergent-labs/release--')) }}
shell: bash -l {0}
working-directory: ${{ matrix.example_directories }}
run: AZLE_PROPTEST_NUM_RUNS=5 AZLE_PROPTEST_VERBOSE=true npm test
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && contains(github.head_ref, 'release--') && !(github.ref == 'refs/heads/main' && contains(github.event.head_commit.message, 'Merge pull request') && contains(github.event.head_commit.message, 'demergent-labs/release--')) }}
shell: bash -l {0}
working-directory: ${{ matrix.example_directories }}
run: AZLE_PROPTEST_NUM_RUNS=10 AZLE_PROPTEST_VERBOSE=true npm test
- if: ${{ needs.release-candidate-deploy.outputs.should_run_tests && (github.ref == 'refs/heads/main' && contains(github.event.head_commit.message, 'Merge pull request') && contains(github.event.head_commit.message, 'demergent-labs/release--')) }}
shell: bash -l {0}
working-directory: ${{ matrix.example_directories }}
run: AZLE_PROPTEST_NUM_RUNS=100 AZLE_PROPTEST_VERBOSE=true npm test
check-basic-integration-tests-success:
needs: basic-integration-tests
runs-on: ubuntu-latest
if: success()
steps:
- run: exit 0
check-basic-integration-tests-failure:
needs: basic-integration-tests
runs-on: ubuntu-latest
if: failure()
steps:
- run: exit 1