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.

Sign up for GitHub

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

Use Routable Locations when Navigating Through Test Plan Tasks #372

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Use Routable Locations when Navigating Through Test Plan Tasks #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5cfeb8
Use routable locations when navigating through testplan tasks.
jkva Dec 6, 2021
f9af3da
Include test task anchor status as part of its accessible name.
jkva Dec 8, 2021
2a12da5
Add test task status tooltip on link focus and hover.
jkva Dec 8, 2021
27b345b
Explicitly map testPlanRunId as number prop.
jkva Dec 8, 2021
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
31 changes: 27 additions & 4 deletions client/components/TestRun/TestNavigator.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ import {
faArrowLeft,
faArrowRight
} from '@fortawesome/free-solid-svg-icons';
import { Col } from 'react-bootstrap';
import React from 'react';
import { Col, Overlay, Tooltip } from 'react-bootstrap';
import React, { useRef, useState } from 'react';

const TestNavigator = ({
show = true,
isSignedIn = false,
tests = [],
currentTestIndex = 0,
testPlanRunId = 0,
toggleShowClick = () => {},
handleTestClick = () => {}
}) => {
Expand Down Expand Up @@ -69,27 +70,48 @@ const TestNavigator = ({
}
}

const [show, setShow] = useState(false);
const target = useRef(null);

return (
<li
className={`test-name-wrapper ${resultClassName}`}
key={`TestNavigatorItem_${test.id}`}
>
<a
href="#"
ref={target}
href={`/run/${testPlanRunId}/task/${test.index +
1}`}
onClick={async () =>
await handleTestClick(test.index)
}
onBlur={() => setShow(false)}
onFocus={() => setShow(true)}
onMouseLeave={() => setShow(false)}
onMouseEnter={() => setShow(true)}
className="test-name"
aria-current={
test.index === currentTestIndex
}
aria-label={`${test.title} (${resultStatus})`}
>
{test.title}
</a>
<span
aria-hidden="true"
className="progress-indicator"
title={`${resultStatus}`}
/>
<Overlay
target={target.current}
show={show}
placement="top-end"
>
{props => (
<Tooltip {...props}>
{resultStatus}
</Tooltip>
)}
</Overlay>
</li>
);
})}
Expand All @@ -107,6 +129,7 @@ TestNavigator.propTypes = {
testResult: PropTypes.object,
conflicts: PropTypes.object,
currentTestIndex: PropTypes.number,
testPlanRunId: PropTypes.number,
toggleShowClick: PropTypes.func,
handleTestClick: PropTypes.func
};
Expand Down
28 changes: 25 additions & 3 deletions client/components/TestRun/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React, { useState, useEffect, useRef } from 'react';
import { Helmet } from 'react-helmet';
import { Link, useParams, useHistory } from 'react-router-dom';
import { Link, useParams, useHistory, Redirect } from 'react-router-dom';
import useRouterQuery from '../../hooks/useRouterQuery';
import { useQuery, useMutation } from '@apollo/client';
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
Expand Down Expand Up @@ -79,7 +79,11 @@ const TestRun = () => {
const testRendererSubmitButtonRef = useRef();
const conflictMarkdownRef = useRef();

const { runId: testPlanRunId, testPlanReportId } = params;
const {
runId: testPlanRunId,
taskId: testPlanTaskId,
testPlanReportId
} = params;

const { loading, data, error, refetch } = useQuery(
testPlanRunId ? TEST_RUN_PAGE_QUERY : TEST_RUN_PAGE_ANON_QUERY,
Expand Down Expand Up @@ -197,7 +201,24 @@ const TestRun = () => {
testResult: testResults.find(t => t.test.id === test.id),
hasConflicts: !!conflicts.find(c => c.source.test.id === test.id)
}));
const currentTest = tests[currentTestIndex];

// Validate any /task/\d+ route parameter
if (
testPlanTaskId !== undefined &&
testPlanTaskId > 0 &&
tests.length < testPlanTaskId
) {
return <Redirect to={{ pathname: '/404' }} />;
}

if (
testPlanTaskId !== undefined &&
testPlanTaskId - 1 !== currentTestIndex
) {
setCurrentTestIndex(testPlanTaskId - 1);
}

const currentTest = tests[testPlanTaskId - 1 || currentTestIndex];
const hasTestsToRun = tests.length;

if (!currentTest.testResult && !pageReadyRef.current && isSignedIn)
Expand Down Expand Up @@ -814,6 +835,7 @@ const TestRun = () => {
<TestNavigator
show={showTestNavigator}
tests={tests}
testPlanRunId={parseInt(testPlanRunId)}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of this explicit int typecasting; why is this not addressed by the routing regular expression?

currentTestIndex={currentTestIndex}
toggleShowClick={toggleTestNavigator}
handleTestClick={handleTestClick}
Expand Down
10 changes: 10 additions & 0 deletions client/routes/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ export default [
path: '/test-plan-report/:testPlanReportId(\\d+)',
component: TestRun
},
{
path: '/run/:runId(\\d+)/task/:taskId(\\d+)',
component: () => {
return (
<ConfirmAuth requiredPermission="TESTER">
<Route component={TestRun} />
</ConfirmAuth>
);
}
},
{
path: '/run/:runId(\\d+)',
component: () => {
Expand Down