opensearch-project/opensearch-benchmark-workloads

Reduce code duplication on 'target_throughput' and 'search_clients' parameters definition

Open

#64 opened on Mar 10, 2023

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Python (137 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem?

Code duplication is introduced by the PR https://github.com/opensearch-project/opensearch-benchmark-workloads/pull/47

The below is the redundant code, which exists in the test procedure definition file for all datasets.

{%- if not target_throughput %}
,"target-throughput": 3
{%- elif target_throughput is string and target_throughput.lower() == 'none' %}
{%- else %}
,"target-throughput": {{ target_throughput | tojson }}
{%- endif %}
{%-if search_clients is defined and search_clients %}
,"clients": {{ search_clients | tojson}}
{%- endif %}

What solution would you like?

By using macros syntax, like commit https://github.com/opensearch-project/opensearch-benchmark-workloads/pull/58/commits/2a7138d050b645a0204334ad9f0a252d2b494889, to reuse the common codes in every file.

What alternatives have you considered?

Put the common codes in a separate file for reusing.

Do you have any additional context?

Coming from https://github.com/opensearch-project/opensearch-benchmark-workloads/pull/58#discussion_r1125144180

Contributor guide

Research direction
Study the existing Jinja macros in the repository, particularly the referenced commit, and identify the common code blocks that can be extracted into a macro. Then create a macro and replace duplicates across all dataset files.
Tech stack
python
Domain
testing
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonJinjaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75