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

feat: arguments mode #1012

Merged
merged 5 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ import Colors from '@styles/Colors';
import Fonts from '@styles/Fonts';

export const ArgumentsWrapper = styled.div`
display: flex;
flex-direction: column;
gap: 32px;

.args-textarea {
color: ${Colors.slate50};

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import React, {useEffect, useMemo} from 'react';

import {Form, Input} from 'antd';
import {Form, Input, Select} from 'antd';

import {ExternalLink} from '@atoms';

import {Button, FullWidthSpace, Text} from '@custom-antd';
import {Button, FormItem, FormItemLabel, FullWidthSpace, Text} from '@custom-antd';

import {useLastCallback} from '@hooks/useLastCallback';

import {ExecutionArgsModeEnum} from '@models/execution';
import {Test} from '@models/test';

import {CopyCommand, notificationCall} from '@molecules';
Expand All @@ -16,6 +17,7 @@ import {CardForm} from '@organisms';

import {Permissions, usePermission} from '@permissions/base';

import {useGetExecutorDetailsByTestTypeQuery} from '@services/executors';
import {useUpdateTestMutation} from '@services/tests';

import {useEntityDetailsPick} from '@store/entityDetails';
Expand All @@ -31,6 +33,7 @@ import {ArgumentsWrapper} from './Arguments.styled';

type ArgumentsFormValues = {
args: string;
argsMode: ExecutionArgsModeEnum;
};

interface ArgumentsProps {
Expand All @@ -45,10 +48,17 @@ const Arguments: React.FC<ArgumentsProps> = ({readOnly}) => {

const [updateTest] = useUpdateTestMutation();

const {data: executorDetails} = useGetExecutorDetailsByTestTypeQuery(encodeURIComponent(details.type));

const entityArgs = details.executionRequest?.args || [];
const initialArgs = useMemo(() => escapeArguments(entityArgs)?.join('\n') || '', [entityArgs]);
const initialArgsMode = useMemo(
() => details.executionRequest?.args_mode || 'append',
[details.executionRequest?.args_mode]
);

const currentArgs = Form.useWatch('args', form) || '';
const argsMode = Form.useWatch('argsMode', form) || 'append';

const prettifiedArgs = useMemo(() => prettifyArguments(currentArgs), [currentArgs]);
const currentArgsInline = useMemo(() => prettifiedArgs.replace(/\n+/g, ' '), [prettifiedArgs]);
Expand All @@ -59,7 +69,7 @@ const Arguments: React.FC<ArgumentsProps> = ({readOnly}) => {
const argVal = currentArgs?.trim().split('\n').filter(Boolean) || [];

// Reset the form when there is no actual change
if (argVal.join('\n') === initialArgs) {
if (argVal.join('\n') === initialArgs && argsMode === initialArgsMode) {
form.resetFields();
}

Expand All @@ -68,6 +78,7 @@ const Arguments: React.FC<ArgumentsProps> = ({readOnly}) => {
executionRequest: {
...details.executionRequest,
args: argVal,
args_mode: argsMode,
},
};

Expand Down Expand Up @@ -98,15 +109,45 @@ const Arguments: React.FC<ArgumentsProps> = ({readOnly}) => {
description="Define arguments which will be passed to the test executor."
footer={footer}
form={form}
initialValues={{args: initialArgs}}
disabled={!mayEdit}
readOnly={readOnly}
initialValues={{args: initialArgs, argsMode: initialArgsMode}}
onConfirm={onSaveForm}
onCancel={onCancel}
>
<ArgumentsWrapper>
<CopyCommand command={currentArgsInline} isBordered additionalPrefix="executor-binary" />
<FormItem
name="argsMode"
key="argsMode"
label={
<FormItemLabel
text="Mode"
tooltipMessage="Choose between appending arguments to the executor or replacing them"
/>
}
>
<Select
options={[
{
label: 'Append',
value: 'append',
},
{
label: 'Replace',
value: 'replace',
},
]}
/>
</FormItem>
<FullWidthSpace size={16} direction="vertical">
<CopyCommand
command={currentArgsInline}
isBordered
additionalPrefix={`executor-binary ${
argsMode === 'append' && executorDetails?.executor.args ? executorDetails?.executor.args.join(' ') : ''
}`}
/>

<Text className="regular middle" color={Colors.slate400}>
Arguments passed to the executor (concat and passed directly to the executor)
</Text>
Expand All @@ -118,9 +159,9 @@ const Arguments: React.FC<ArgumentsProps> = ({readOnly}) => {
}}
className="args-textarea"
placeholder={`--flag="value value"
--flag-123=value
value
`}
--flag-123=value
value
`}
/>
</Form.Item>
<Button onClick={onPrettify} $customType="secondary" disabled={isPrettified || readOnly}>
Expand Down
3 changes: 3 additions & 0 deletions packages/web/src/models/execution.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export const executionStatusList = ['running', 'passed', 'failed', 'queued', 'ti
export type ExecutionStatusEnum = (typeof executionStatusList)[number];
export type ExecutionResultOutputTypeEnum = 'text/plain' | 'application/junit+xml' | 'application/json';
export type ExecutionStepResultStatusEnum = 'success' | 'error';
export type ExecutionArgsModeEnum = 'append' | 'replace';

export type ExecutionStepResult = {
name: string;
Expand All @@ -35,6 +36,7 @@ export type Execution = {
name: string;
envs: EntityMap;
args: Args;
args_mode?: ExecutionArgsModeEnum;
params: EntityMap;
paramsFile: string;
content: TestContent;
Expand Down Expand Up @@ -62,6 +64,7 @@ export type ExecutionRequest = {
testSecretUUID: string;
testSuiteSecretUUID: string;
args: Args;
args_mode?: ExecutionArgsModeEnum;
image: string;
envs: EntityMap;
secretEnvs: EntityMap;
Expand Down
6 changes: 6 additions & 0 deletions packages/web/src/services/executors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ export const executorsApi = createApi({
}),
providesTags: (res, err, id) => [{type: 'Executor', id}],
}),
getExecutorDetailsByTestType: builder.query<any, string>({
query: testType => ({
url: `/executor-by-types?testType=${testType}`,
}),
}),
deleteExecutor: builder.mutation<void, string>({
query: id => ({
url: `/executors/${id}`,
Expand Down Expand Up @@ -82,6 +87,7 @@ export const {
useCreateExecutorMutation,
useGetExecutorDefinitionQuery,
useGetExecutorDetailsQuery,
useGetExecutorDetailsByTestTypeQuery,
useDeleteExecutorMutation,
useUpdateCustomExecutorMutation,
useUpdateExecutorDefinitionMutation,
Expand Down
Loading