Skip to content
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

Modularize the user test modules #341

Closed
aklenik opened this issue Mar 5, 2019 · 1 comment
Closed

Modularize the user test modules #341

aklenik opened this issue Mar 5, 2019 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@aklenik
Copy link
Contributor

aklenik commented Mar 5, 2019

Context

Caliper uses user modules (or user test modules) to allow arbitrary workload logic to be plugged in. The user module must export the three required functions to be able to interact with Caliper. This design is not object-oriented and should be refactored.

Expected Behavior

The proposal is to require only an exported factory function (e.g., createUserModule) from the user module JS file. This way the developer has more freedom to structure the implementation and explicitly manage the life-cycle of the user module instance.

Corresponding documentation must also be provided that describes the general API of user modules.

Possible Fix

The src/comm/client/local-client.js/run* functions must be refactored to use the new factory function of the referenced modules.
Additionally, the provided example user modules (in the benchmark/ directory) must also be refactored.

@aklenik aklenik added enhancement New feature or request good first issue Good for newcomers labels Mar 5, 2019
@aklenik aklenik added this to the v0.3.0 milestone Nov 5, 2019
@aklenik aklenik modified the milestones: v0.3.0, v0.4.0 May 6, 2020
@aklenik
Copy link
Contributor Author

aklenik commented Jun 24, 2020

Closed by #856

@aklenik aklenik closed this as completed Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant