Release 2.0.0 rc.2 #45
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
introduce a test which mimics a user login flow, based on the koko load test concept introduce a test which navigates through a configurable folder tree, based on the koko load test concept introduce a test which simulates an upload delete workflow, based on the koko load test concept introduce a test which simulates an upload download workflow, based on the koko load test concept introduce a test which creates and renames nested folders, based on the koko load test concept introduce sample tests to show all contained options from the k6-tdk introduce k6-tdk (test development kit) which exposes building blocks to work with the individual clouds (api, client, utils, auth) introduce private esbuild package which contains shared building blocks introduce private eslint config package which contains shared eslint configurations introduce private tsconfig config package which contains shared typescript configurations introduce private turbowatch package which contains shared watcher configurations switch from yarn to pnpm use a monorepo structure and introduce turbo, esbuild and turbowatch to speed up the development
k6-tdk now exports virtual sub packages and is now available in cjs and esm format [skip ci]
@ownclouders/k6-tdk utils now export the k6 helpers directly without the namespace
add test docs for each test
This was referenced Mar 30, 2023
k6-tdk disable virtual package sideEffects explicitly
dragotin
approved these changes
Mar 31, 2023
|
Maybe stupid questions
|
|
i switched the pr back to |
the order and naming is from the load testing paper (closed source), the gaps are easy to explain, those tests are still missing and i provide them in a separate PR later. |
- add more detail to the navigate folder test description - fix some wordings in the readme - build the vLib's after esbuild emission - use platform node as default in the shared build setup - update watch glob expression to only watch package src and pnpm workspace dist folders
JammingBen
approved these changes
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
mmattel
reviewed
Apr 3, 2023
Co-authored-by: Martin <github@diemattels.at>
JammingBen
reviewed
Apr 3, 2023
| @@ -41,7 +41,7 @@ We collect those metrics over time to get indicators of how the performance chan | |||
| for a more detailed instruction how to read the results you should consider reading the k6 manual, | |||
| specially the [end of test](https://k6.io/docs/results-output/end-of-test/) section. | |||
|
|
|||
| ## Available test suits | |||
| ## Test Suits | |||
There was a problem hiding this comment.
I didn't mean to remove the Available, but the e was missing in Suits - sorry for the confusion.
Suggested change
| ## Test Suits | |
| ## Available Test Suites |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
How to review (what)
Overview
first of all, sorry for the pr size, under the given circumstances it was unfortunately not possible to keep it smaller,
the foundations for this pr were laid in the rc.1, and every function builds on that.
this pr introduces several things, and i will list them before i go into detail.
koko-010-logintest and documentationkoko-020-navigate-file-treetest and documentationkoko-040-upload-deletetest and documentationkoko-050-upload-downloadtest and documentationkoko-060-create-rename-foldertest and documentationsample-kitchen-sinktest and documentationto explain it in one sentence, it contains the needed buildingblocks and tests to be able to fulfil the koko load testing paper!
ok now let me explain in detail what this is all about.
k6-tdk
One of the main reasons of cdPerf is to be able to tests the 3 major cloud platforms, to do so the api must be aligned.
Since we've already started to introduce new apis in ocis we've needed a way to use the old and new api's side by side in the same test scenario. Thats the reason why i've created the k6-tdk (k6 test development toolkit).
It should speed up test development and abstract away the compatibility problem.
k6-tests
this maybe is the most important part, it should enable us to test oCis (other clouds work too) while developing it, but also prove the tests required by the koko performance paper (sorry, sources are private). Beside the koko specific tests it also contain other valuable test scenarios, let me list and explain all of those:
koko-010-login
The
logintest is intended to log a configurable number of users into the system and then log out again. The purpose of the test is primarily to put the idp under load and see how it handles it.https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/koko/010-login.md
koko-020-navigate-file-tree
The
navigate file treetest is intended to see how the instance behaves when many users move through a configurable deep folder hierarchy at the same time.https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/koko/020-navigate-file-tree.md
koko-040-upload-delete
The
upload deletetest is intended to see how the instance behaves when many users upload N files of size S, M and L each, and then deletes them again.https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/koko/040-upload-delete.md
koko-050-upload-download
The
upload downloadtest is intended to see how the instance behaves when many users upload N files of size S, M and L each, and then download each.https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/koko/050-upload-download.md
koko-060-create-rename-folder
The
create rename foldertest is intended to see how the instance behaves when many users move through a configurabledeep folder hierarchy and then rename each of these folders after entering.
https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/koko/060-create-rename-folder.md
oc-share-upload-rename
The
share upload renametest mimics a typical end user resource sharing scenario.The admin user shares a parent folder with each of his colleagues, who in turn create a folder
in the received share per iteration and user then uploads a fixed number of files.
To finish, the folder in which the files are located is renamed by each user.
https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/oc/share-upload-rename.md
sample-kitchen-sink
The
kitchen sinktest is intended to demonstrate the whole api and client from our k6-tdk (k6 test development kit).The test does not follow any user story, it is a good starting point to get inspired how the framework can be used.
https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/sample/kitchen-sink.md
surf-upload
The
uploadtest mimics a typical end user resource uploading scenario.The test idea originally came from surf, where the process was used to compare the individual cloud platforms.
https://github.com/owncloud/cdperf/blob/next-rc2/packages/k6-tests/src/surf/upload.md
misc
--vus 2 --iterations 10ownCloud classic,nextCloudandoCisand uses the newest (and different) api's for each.setup) and manages the teardown on its own, the tests are self containing, no preparation needed.BASE_URL,AUTH_ADAPTER,API_VERSION,ADMIN_LOGIN,ADMIN_PASSWORD `, please read the test docs (*.md) to get a deep dive and list of available options.ToDo's