Skip to content

Commit 66be084

Browse files
Merge #1347
1347: Standardise naming convention of Private and Public keys in test to Admin and Search respectively. r=bidoubiwa a=viveknshah # Pull Request Standardise naming convention of Private and Public keys in test to Admin and Seach respectively ## Related issue Fixes #1137 ## What does this PR do? -Standardises the naming convention of Index and Admin Keys in the tests by updating the remaining Private and Public string constants been passed. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: viveknshah <[email protected]> Co-authored-by: Vivek Shah <[email protected]>
2 parents 8ae2369 + 07192f5 commit 66be084

24 files changed

+58
-58
lines changed

tests/client.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ afterAll(() => {
2424

2525
describe.each([
2626
{ permission: 'Master' },
27-
{ permission: 'Private' },
28-
{ permission: 'Public' },
27+
{ permission: 'Admin' },
28+
{ permission: 'Search' },
2929
])('Test on client instance', ({ permission }) => {
3030
beforeEach(() => {
3131
return clearAllIndexes(config)
@@ -149,7 +149,7 @@ describe.each([
149149
})
150150
})
151151

152-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
152+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
153153
'Test on client w/ master and admin key',
154154
({ permission }) => {
155155
beforeEach(() => {
@@ -408,7 +408,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
408408
}
409409
)
410410

411-
describe.each([{ permission: 'Public' }])(
411+
describe.each([{ permission: 'Search' }])(
412412
'Test on misc client methods w/ search apikey',
413413
({ permission }) => {
414414
beforeEach(() => {

tests/displayed_attributes.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ afterAll(() => {
1818
return clearAllIndexes(config)
1919
})
2020

21-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
21+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2222
'Test on displayed attributes',
2323
({ permission }) => {
2424
beforeEach(async () => {
@@ -72,7 +72,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
7272
}
7373
)
7474

75-
describe.each([{ permission: 'Public' }])(
75+
describe.each([{ permission: 'Search' }])(
7676
'Test on displayed attributes',
7777
({ permission }) => {
7878
beforeEach(async () => {

tests/distinct_attribute.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ afterAll(() => {
1818
return clearAllIndexes(config)
1919
})
2020

21-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
21+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2222
'Test on distinct attribute',
2323
({ permission }) => {
2424
beforeEach(async () => {
@@ -70,7 +70,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
7070
}
7171
)
7272

73-
describe.each([{ permission: 'Public' }])(
73+
describe.each([{ permission: 'Search' }])(
7474
'Test on distinct attribute',
7575
({ permission }) => {
7676
beforeEach(async () => {

tests/documents.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ afterAll(() => {
2424
})
2525

2626
describe('Documents tests', () => {
27-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
27+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2828
'Test on documents',
2929
({ permission }) => {
3030
beforeEach(async () => {
@@ -477,7 +477,7 @@ describe('Documents tests', () => {
477477
}
478478
)
479479

480-
describe.each([{ permission: 'Public' }])(
480+
describe.each([{ permission: 'Search' }])(
481481
'Test on documents',
482482
({ permission }) => {
483483
beforeEach(() => {

tests/dump.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ beforeEach(async () => {
1111
await clearAllIndexes(config)
1212
})
1313

14-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
14+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
1515
'Test on dump',
1616
({ permission }) => {
1717
test(`${permission} key: create a new dump`, async () => {
@@ -23,7 +23,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
2323
}
2424
)
2525

26-
describe.each([{ permission: 'Public' }])(
26+
describe.each([{ permission: 'Search' }])(
2727
'Test on dump with search api key should not have access',
2828
({ permission }) => {
2929
test(`${permission} key: try to create dump with search key and be denied`, async () => {

tests/faceting.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ afterAll(() => {
1818
return clearAllIndexes(config)
1919
})
2020

21-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
21+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2222
'Test on faceting',
2323
({ permission }) => {
2424
beforeEach(async () => {
@@ -85,7 +85,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
8585
}
8686
)
8787

88-
describe.each([{ permission: 'Public' }])(
88+
describe.each([{ permission: 'Search' }])(
8989
'Test on faceting',
9090
({ permission }) => {
9191
beforeEach(async () => {

tests/filterable_attributes.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ afterAll(() => {
1818
return clearAllIndexes(config)
1919
})
2020

21-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
21+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2222
'Test on searchable attributes',
2323
({ permission }) => {
2424
beforeEach(async () => {
@@ -78,7 +78,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
7878
}
7979
)
8080

81-
describe.each([{ permission: 'Public' }])(
81+
describe.each([{ permission: 'Search' }])(
8282
'Test on attributes for filtering',
8383
({ permission }) => {
8484
beforeEach(async () => {

tests/get_search.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ afterAll(() => {
6363

6464
describe.each([
6565
{ permission: 'Master' },
66-
{ permission: 'Private' },
67-
{ permission: 'Public' },
66+
{ permission: 'Admin' },
67+
{ permission: 'Search' },
6868
])('Test on GET search', ({ permission }) => {
6969
beforeAll(async () => {
7070
await clearAllIndexes(config)

tests/index.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ afterAll(async () => {
1919
return clearAllIndexes(config)
2020
})
2121

22-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
22+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2323
'Test on indexes w/ master and admin key',
2424
({ permission }) => {
2525
beforeEach(() => {
@@ -393,7 +393,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
393393
}
394394
)
395395

396-
describe.each([{ permission: 'Public' }])(
396+
describe.each([{ permission: 'Search' }])(
397397
'Test on routes with search key',
398398
({ permission }) => {
399399
beforeEach(() => {

tests/keys.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ afterAll(() => {
1616
return clearAllIndexes(config)
1717
})
1818

19-
describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
19+
describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
2020
'Test on keys',
2121
({ permission }) => {
2222
beforeEach(async () => {
@@ -87,7 +87,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
8787

8888
test(`${permission} key: get on key`, async () => {
8989
const client = await getClient(permission)
90-
const apiKey = await getKey('Private')
90+
const apiKey = await getKey('Admin')
9191

9292
const key = await client.getKey(apiKey)
9393

@@ -203,7 +203,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
203203
}
204204
)
205205

206-
describe.each([{ permission: 'Public' }])(
206+
describe.each([{ permission: 'Search' }])(
207207
'Test on keys with search key',
208208
({ permission }) => {
209209
test(`${permission} key: get keys denied`, async () => {

0 commit comments

Comments
 (0)