Skip to content

Commit 9a2da1b

Browse files
spalmurray-codecovspalmurray-codecov
authored
chore: Add testing framework to GHA token step metric (#3773)
1 parent 40c29d5 commit 9a2da1b

File tree

11 files changed

+39
-13
lines changed

11 files changed

+39
-13
lines changed

‎.eslintrc.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ module.exports = {
283283
files: ['src/**/*.{js,jsx,ts,tsx}'],
284284
rules: {
285285
'no-restricted-syntax': [
286-
'warn',
286+
'error',
287287
{
288288
selector:
289289
'Literal[value=/\\bGithub\\b|\\bGitlab\\b|\\bBitBucket\\b/], JSXText[value=/\\bGithub\\b|\\bGitlab\\b|\\bBitBucket\\b/]',

‎src/pages/LoginPage/LoginPage.test.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ describe('LoginPage', () => {
9393
describe('when the url is /login/gh', () => {
9494
beforeEach(() => setup())
9595

96-
it('renders the Github login button', () => {
96+
it('renders the GitHub login button', () => {
9797
render(<LoginPage />, { wrapper: wrapper('/login/gh') })
9898

9999
const githubLink = screen.getByRole('link', {

‎src/pages/PlanPage/subRoutes/CurrentOrgPlan/CurrentPlanCard/shared/ActionsBilling/ActionsBilling.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ function ActionsBilling() {
8080
<div className="flex flex-col gap-4 border-ds-gray-secondary">
8181
<hr />
8282
<div className="flex gap-4">
83-
<img className="size-8" alt="Github" src={githubLogo} />
83+
<img className="size-8" alt="GitHub" src={githubLogo} />
8484
<p className="text-sm">
8585
Your account is configured via GitHub Marketplace
8686
</p>

‎src/pages/PlanPage/subRoutes/UpgradePlanPage/UpgradeForm/Controllers/ProPlanController/BillingOptions/BillingOptions.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ describe('BillingOptions', () => {
155155

156156
const annualBtn = await screen.findByRole('button', { name: 'Annual' })
157157
expect(annualBtn).toBeInTheDocument()
158-
expect(annualBtn).toHaveClass('bg-ds-primary-base')
158+
await waitFor(() => expect(annualBtn).toHaveClass('bg-ds-primary-base'))
159159

160160
const monthlyBtn = await screen.findByRole('button', {
161161
name: 'Monthly',

‎src/pages/PlanPage/subRoutes/UpgradePlanPage/UpgradeForm/Controllers/TeamPlanController/BillingOptions/BillingOptions.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ describe('BillingOptions', () => {
138138

139139
const annualBtn = await screen.findByRole('button', { name: 'Annual' })
140140
expect(annualBtn).toBeInTheDocument()
141-
expect(annualBtn).toHaveClass('bg-ds-primary-base')
141+
await waitFor(() => expect(annualBtn).toHaveClass('bg-ds-primary-base'))
142142

143143
const monthlyBtn = await screen.findByRole('button', {
144144
name: 'Monthly',

‎src/pages/RepoPage/CoverageOnboarding/GitHubActions/GitHubActions.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ function GitHubActions() {
7878
setIsUsingGlobalToken={setIsUsingGlobalToken}
7979
showAddTokenStep={showAddTokenStep}
8080
showTokenSelector={showTokenSelector}
81+
framework={framework}
8182
/>
8283
<WorkflowYMLStep
8384
framework={framework}

‎src/pages/RepoPage/CoverageOnboarding/GitHubActions/TokenStep.test.tsx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ describe('TokenStepSection', () => {
113113
showTokenSelector={true}
114114
isUsingGlobalToken={false}
115115
setIsUsingGlobalToken={vi.fn()}
116+
framework="Jest"
116117
/>,
117118
{
118119
wrapper: wrapper(),
@@ -132,6 +133,7 @@ describe('TokenStepSection', () => {
132133
showTokenSelector={false}
133134
isUsingGlobalToken={true}
134135
setIsUsingGlobalToken={vi.fn()}
136+
framework="Jest"
135137
/>,
136138
{
137139
wrapper: wrapper(),
@@ -150,6 +152,7 @@ describe('TokenStepSection', () => {
150152
showTokenSelector={false}
151153
isUsingGlobalToken={false}
152154
setIsUsingGlobalToken={vi.fn()}
155+
framework="Jest"
153156
/>,
154157
{
155158
wrapper: wrapper(),
@@ -168,6 +171,7 @@ describe('TokenStepSection', () => {
168171
showTokenSelector={true}
169172
isUsingGlobalToken={false}
170173
setIsUsingGlobalToken={vi.fn()}
174+
framework="Jest"
171175
/>,
172176
{
173177
wrapper: wrapper(),
@@ -185,6 +189,7 @@ describe('TokenStepSection', () => {
185189
showTokenSelector={true}
186190
isUsingGlobalToken={true}
187191
setIsUsingGlobalToken={vi.fn()}
192+
framework="Jest"
188193
/>,
189194
{
190195
wrapper: wrapper(),
@@ -205,6 +210,7 @@ describe('TokenStepSection', () => {
205210
showTokenSelector={true}
206211
isUsingGlobalToken={false}
207212
setIsUsingGlobalToken={vi.fn()}
213+
framework="Jest"
208214
/>,
209215
{
210216
wrapper: wrapper(),
@@ -229,6 +235,7 @@ describe('TokenStepSection', () => {
229235
showTokenSelector={true}
230236
isUsingGlobalToken={true}
231237
setIsUsingGlobalToken={vi.fn()}
238+
framework="Jest"
232239
/>,
233240
{
234241
wrapper: wrapper(),
@@ -247,6 +254,7 @@ describe('TokenStepSection', () => {
247254
showTokenSelector={true}
248255
isUsingGlobalToken={true}
249256
setIsUsingGlobalToken={vi.fn()}
257+
framework="Jest"
250258
/>,
251259
{
252260
wrapper: wrapper(),
@@ -269,6 +277,7 @@ describe('TokenStepSection', () => {
269277
showTokenSelector={true}
270278
isUsingGlobalToken={true}
271279
setIsUsingGlobalToken={vi.fn()}
280+
framework="Jest"
272281
/>,
273282
{
274283
wrapper: wrapper(),
@@ -289,6 +298,7 @@ describe('TokenStepSection', () => {
289298
showTokenSelector={true}
290299
isUsingGlobalToken={true}
291300
setIsUsingGlobalToken={vi.fn()}
301+
framework="Jest"
292302
/>,
293303
{
294304
wrapper: wrapper(),
@@ -308,6 +318,7 @@ describe('TokenStepSection', () => {
308318
showTokenSelector={true}
309319
isUsingGlobalToken={true}
310320
setIsUsingGlobalToken={vi.fn()}
321+
framework="Jest"
311322
/>,
312323
{
313324
wrapper: wrapper(),
@@ -329,6 +340,7 @@ describe('TokenStepSection', () => {
329340
showTokenSelector={true}
330341
isUsingGlobalToken={false}
331342
setIsUsingGlobalToken={vi.fn()}
343+
framework="Jest"
332344
/>,
333345
{
334346
wrapper: wrapper(),
@@ -351,6 +363,7 @@ describe('TokenStepSection', () => {
351363
showTokenSelector={true}
352364
isUsingGlobalToken={true}
353365
setIsUsingGlobalToken={vi.fn()}
366+
framework="Jest"
354367
/>,
355368
{
356369
wrapper: wrapper(),
@@ -371,6 +384,7 @@ describe('TokenStepSection', () => {
371384
showTokenSelector={true}
372385
isUsingGlobalToken={false}
373386
setIsUsingGlobalToken={vi.fn()}
387+
framework="Jest"
374388
/>,
375389
{
376390
wrapper: wrapper(),

‎src/pages/RepoPage/CoverageOnboarding/GitHubActions/TokenStep.tsx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ import { ExpandableSection } from 'ui/ExpandableSection'
1919
import LightDarkImg from 'ui/LightDarkImg'
2020
import { RadioTileGroup } from 'ui/RadioTileGroup'
2121

22+
import { Framework } from '../UseFrameworkInstructions'
23+
2224
export const TOKEN_OPTIONS = {
2325
GLOBAL: 'global',
2426
REPO: 'repo',
@@ -33,11 +35,13 @@ interface URLParams {
3335
interface SecretGHExampleProps {
3436
isUsingGlobalToken: boolean
3537
uploadToken: string
38+
framework: Framework
3639
}
3740

3841
function GitHubOrgSecretExample({
3942
isUsingGlobalToken,
4043
uploadToken,
44+
framework,
4145
}: SecretGHExampleProps) {
4246
return (
4347
<>
@@ -64,6 +68,7 @@ function GitHubOrgSecretExample({
6468
buttonName: 'Copy',
6569
buttonLocation: 'Coverage onboarding',
6670
ciProvider: 'GitHub Actions',
71+
testingFramework: framework,
6772
copied: 'Upload token',
6873
},
6974
})
@@ -176,9 +181,11 @@ function OrgOrRepoTokenSelector({
176181
const AddTokenStep = ({
177182
stepNum,
178183
isUsingGlobalToken,
184+
framework,
179185
}: {
180186
stepNum: number
181187
isUsingGlobalToken: boolean
188+
framework: Framework
182189
}) => {
183190
const { provider, owner, repo } = useParams<URLParams>()
184191
const { data: orgUploadToken } = useOrgUploadToken({
@@ -217,6 +224,7 @@ const AddTokenStep = ({
217224
uploadToken={
218225
isUsingGlobalToken ? (orgUploadToken ?? '') : repoUploadToken
219226
}
227+
framework={framework}
220228
/>
221229
</Card.Content>
222230
</Card>
@@ -228,13 +236,15 @@ interface TokenStepSectionProps {
228236
setIsUsingGlobalToken: (value: boolean) => void
229237
showAddTokenStep: boolean
230238
showTokenSelector: boolean
239+
framework: Framework
231240
}
232241

233242
function TokenStepSection({
234243
isUsingGlobalToken,
235244
setIsUsingGlobalToken,
236245
showAddTokenStep,
237246
showTokenSelector,
247+
framework,
238248
}: TokenStepSectionProps) {
239249
const { provider, owner } = useParams<URLParams>()
240250
const { data: uploadTokenRequiredData } = useUploadTokenRequired({
@@ -278,6 +288,7 @@ function TokenStepSection({
278288
<AddTokenStep
279289
stepNum={showTokenSelector ? 3 : 2}
280290
isUsingGlobalToken={isUsingGlobalToken}
291+
framework={framework}
281292
/>
282293
)}
283294
</>

‎src/services/navigation/useStaticNavLinks.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,21 +196,21 @@ export function useStaticNavLinks() {
196196
codecovGithubApp: {
197197
path: () => `https://github.com/apps/${config.GH_APP}`,
198198
isExternalLink: true,
199-
text: 'Codecov Github App',
199+
text: 'Codecov GitHub App',
200200
openNewTab: true,
201201
},
202202
codecovGithubAppSelectTarget: {
203203
path: () =>
204204
`https://github.com/apps/${config.GH_APP}/installations/select_target`,
205205
isExternalLink: true,
206-
text: 'Codecov Github App',
206+
text: 'Codecov GitHub App',
207207
openNewTab: true,
208208
},
209209
githubRateLimitExceeded: {
210210
path: () =>
211211
'https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api',
212212
isExternalLink: true,
213-
text: 'Github documentation',
213+
text: 'GitHub documentation',
214214
openNewTab: true,
215215
},
216216
teamBot: {
@@ -408,14 +408,14 @@ export function useStaticNavLinks() {
408408
openNewTab: true,
409409
},
410410
codecovExampleJSCircleCIWorkflow: {
411-
text: 'Github Codecov Example CircleCI JS workflow',
411+
text: 'GitHub Codecov Example CircleCI JS workflow',
412412
path: () =>
413413
'https://github.com/codecov/example-javascript/blob/main/.circleci/config.yml',
414414
isExternalLink: true,
415415
openNewTab: true,
416416
},
417417
codecovExampleJSCircleCIWorkflowSteps: {
418-
text: 'Github Codecov Example CircleCI JS workflow',
418+
text: 'GitHub Codecov Example CircleCI JS workflow',
419419
path: () =>
420420
'https://app.circleci.com/pipelines/github/codecov/example-javascript/148/workflows/180ae354-0d8c-4205-8815-f4c516a042a4/jobs/130/steps',
421421
isExternalLink: true,

‎src/shared/api/api.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const rawUserData = {
1515
},
1616
orgs: [
1717
{ id: 1, long_name: 'Codecov' },
18-
{ id: 2, long_name: 'Github' },
18+
{ id: 2, long_name: 'GitHub' },
1919
],
2020
}
2121

@@ -27,7 +27,7 @@ const userData = {
2727
},
2828
orgs: [
2929
{ id: 1, longName: 'Codecov' },
30-
{ id: 2, longName: 'Github' },
30+
{ id: 2, longName: 'GitHub' },
3131
],
3232
}
3333

0 commit comments

Comments
 (0)