Skip to content

[Snapshot and Restore] Update help text for common repository settings #97652

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

Merged
alisonelizabeth merged 12 commits into from
Apr 23, 2021
Merged

[Snapshot and Restore] Update help text for common repository settings #97652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
be29c3b
update help text for common repository settings
alisonelizabeth Apr 20, 2021
1459158
update i18n
alisonelizabeth Apr 20, 2021
717ca17
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
7380faa
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
da83a3f
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
ccd9388
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
b12e7f2
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
e39a78f
Update x-pack/plugins/snapshot_restore/public/application/components/…
alisonelizabeth Apr 21, 2021
c9df9af
Merge branch 'master' into sr/repository_help_text
kibanamachine Apr 21, 2021
b8c8476
Merge branch 'master' of https://github.com/elastic/kibana into sr/re…
alisonelizabeth Apr 23, 2021
189408c
address review feedback
alisonelizabeth Apr 23, 2021
718b9a4
fix linting error
alisonelizabeth Apr 23, 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
7 changes: 7 additions & 0 deletions ...ck/plugins/snapshot_restore/__jest__/client_integration/helpers/repository_add.helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@ type TestSubjects =
| 'compressToggle'
| 'fsRepositoryType'
| 'locationInput'
| 'clientInput'
| 'containerInput'
| 'basePathInput'
| 'bucketInput'
| 'pathInput'
| 'uriInput'
| 'bufferSizeInput'
| 'maxRestoreBytesInput'
| 'maxSnapshotBytesInput'
| 'nameInput'
Expand Down
266 changes: 242 additions & 24 deletions x-pack/plugins/snapshot_restore/__jest__/client_integration/repository_add.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,14 @@ describe('<RepositoryAdd />', () => {
});

describe('form payload & api errors', () => {
const repository = getRepository();
const fsRepository = getRepository({
settings: {
chunkSize: '10mb',
location: '/tmp/es-backups',
maxSnapshotBytesPerSec: '1g',
maxRestoreBytesPerSec: '1g',
},
});

beforeEach(async () => {
httpRequestsMockHelpers.setLoadRepositoryTypesResponse(repositoryTypes);
Expand All @@ -202,41 +209,251 @@ describe('<RepositoryAdd />', () => {
});

describe('not source only', () => {
beforeEach(() => {
test('should send the correct payload for FS repository', async () => {
const { form, actions, component } = testBed;

// Fill step 1 required fields and go to step 2
testBed.form.setInputValue('nameInput', repository.name);
testBed.actions.selectRepositoryType(repository.type);
testBed.actions.clickNextButton();
form.setInputValue('nameInput', fsRepository.name);
actions.selectRepositoryType(fsRepository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('locationInput', fsRepository.settings.location);
form.toggleEuiSwitch('compressToggle');
form.setInputValue('chunkSizeInput', fsRepository.settings.chunkSize);
form.setInputValue('maxSnapshotBytesInput', fsRepository.settings.maxSnapshotBytesPerSec);
form.setInputValue('maxRestoreBytesInput', fsRepository.settings.maxRestoreBytesPerSec);
form.toggleEuiSwitch('readOnlyToggle');

await act(async () => {
actions.clickSubmitButton();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: fsRepository.name,
type: fsRepository.type,
settings: {
...fsRepository.settings,
compress: true,
readonly: true,
},
});
});

test('should send the correct payload', async () => {
const { form, actions } = testBed;
test('should send the correct payload for Azure repository', async () => {
const azureRepository = getRepository({
type: 'azure',
settings: {
chunkSize: '10mb',
maxSnapshotBytesPerSec: '1g',
maxRestoreBytesPerSec: '1g',
client: 'client',
container: 'container',
basePath: 'path',
},
});

const { form, actions, component } = testBed;

// Fill step 1 required fields and go to step 2
form.setInputValue('nameInput', azureRepository.name);
actions.selectRepositoryType(azureRepository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('locationInput', repository.settings.location);
form.setInputValue('clientInput', azureRepository.settings.client);
form.setInputValue('containerInput', azureRepository.settings.container);
form.setInputValue('basePathInput', azureRepository.settings.basePath);
form.toggleEuiSwitch('compressToggle');
form.setInputValue('chunkSizeInput', azureRepository.settings.chunkSize);
form.setInputValue(
'maxSnapshotBytesInput',
azureRepository.settings.maxSnapshotBytesPerSec
);
form.setInputValue('maxRestoreBytesInput', azureRepository.settings.maxRestoreBytesPerSec);
form.toggleEuiSwitch('readOnlyToggle');

await act(async () => {
actions.clickSubmitButton();
await nextTick();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: repository.name,
type: repository.type,
name: azureRepository.name,
type: azureRepository.type,
settings: {
location: repository.settings.location,
compress: true,
...azureRepository.settings,
compress: false,
readonly: true,
},
});
});

test('should send the correct payload for GCS repository', async () => {
const gcsRepository = getRepository({
type: 'gcs',
settings: {
chunkSize: '10mb',
maxSnapshotBytesPerSec: '1g',
maxRestoreBytesPerSec: '1g',
client: 'test_client',
bucket: 'test_bucket',
basePath: 'test_path',
},
});

const { form, actions, component } = testBed;

// Fill step 1 required fields and go to step 2
form.setInputValue('nameInput', gcsRepository.name);
actions.selectRepositoryType(gcsRepository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('clientInput', gcsRepository.settings.client);
form.setInputValue('bucketInput', gcsRepository.settings.bucket);
form.setInputValue('basePathInput', gcsRepository.settings.basePath);
form.toggleEuiSwitch('compressToggle');
form.setInputValue('chunkSizeInput', gcsRepository.settings.chunkSize);
form.setInputValue('maxSnapshotBytesInput', gcsRepository.settings.maxSnapshotBytesPerSec);
form.setInputValue('maxRestoreBytesInput', gcsRepository.settings.maxRestoreBytesPerSec);
form.toggleEuiSwitch('readOnlyToggle');

await act(async () => {
actions.clickSubmitButton();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: gcsRepository.name,
type: gcsRepository.type,
settings: {
...gcsRepository.settings,
compress: false,
readonly: true,
},
});
});

test('should send the correct payload for HDFS repository', async () => {
const hdfsRepository = getRepository({
type: 'hdfs',
settings: {
uri: 'uri',
path: 'test_path',
chunkSize: '10mb',
maxSnapshotBytesPerSec: '1g',
maxRestoreBytesPerSec: '1g',
},
});

const { form, actions, component } = testBed;

// Fill step 1 required fields and go to step 2
form.setInputValue('nameInput', hdfsRepository.name);
actions.selectRepositoryType(hdfsRepository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('uriInput', hdfsRepository.settings.uri);
form.setInputValue('pathInput', hdfsRepository.settings.path);
form.toggleEuiSwitch('compressToggle');
form.setInputValue('chunkSizeInput', hdfsRepository.settings.chunkSize);
form.setInputValue('maxSnapshotBytesInput', hdfsRepository.settings.maxSnapshotBytesPerSec);
form.setInputValue('maxRestoreBytesInput', hdfsRepository.settings.maxRestoreBytesPerSec);
form.toggleEuiSwitch('readOnlyToggle');

await act(async () => {
actions.clickSubmitButton();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: hdfsRepository.name,
type: hdfsRepository.type,
settings: {
...hdfsRepository.settings,
uri: `hdfs://${hdfsRepository.settings.uri}`,
compress: false,
readonly: true,
},
});
});

test('should send the correct payload for S3 repository', async () => {
const { form, actions, component } = testBed;

const s3Repository = getRepository({
type: 's3',
settings: {
bucket: 'test_bucket',
client: 'test_client',
basePath: 'test_path',
bufferSize: '1g',
chunkSize: '10mb',
maxSnapshotBytesPerSec: '1g',
maxRestoreBytesPerSec: '1g',
},
});

// Fill step 1 required fields and go to step 2
form.setInputValue('nameInput', s3Repository.name);
actions.selectRepositoryType(s3Repository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('bucketInput', s3Repository.settings.bucket);
form.setInputValue('clientInput', s3Repository.settings.client);
form.setInputValue('basePathInput', s3Repository.settings.basePath);
form.setInputValue('bufferSizeInput', s3Repository.settings.bufferSize);
form.toggleEuiSwitch('compressToggle');
form.setInputValue('chunkSizeInput', s3Repository.settings.chunkSize);
form.setInputValue('maxSnapshotBytesInput', s3Repository.settings.maxSnapshotBytesPerSec);
form.setInputValue('maxRestoreBytesInput', s3Repository.settings.maxRestoreBytesPerSec);
form.toggleEuiSwitch('readOnlyToggle');

await act(async () => {
actions.clickSubmitButton();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: s3Repository.name,
type: s3Repository.type,
settings: {
...s3Repository.settings,
compress: false,
readonly: true,
},
});
});

test('should surface the API errors from the "save" HTTP request', async () => {
const { component, form, actions, find, exists } = testBed;

form.setInputValue('locationInput', repository.settings.location);
// Fill step 1 required fields and go to step 2
form.setInputValue('nameInput', fsRepository.name);
actions.selectRepositoryType(fsRepository.type);
actions.clickNextButton();

// Fill step 2
form.setInputValue('locationInput', fsRepository.settings.location);
form.toggleEuiSwitch('compressToggle');

const error = {
Expand All @@ -249,10 +466,10 @@ describe('<RepositoryAdd />', () => {

await act(async () => {
actions.clickSubmitButton();
await nextTick();
Copy link
Copy Markdown
Contributor

@sebelga sebelga Apr 23, 2021

Choose a reason for hiding this comment

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

Great! So we still have some of those nextTick floating around.. 🤔

Copy link
Copy Markdown
Contributor Author

@alisonelizabeth alisonelizabeth Apr 23, 2021

Choose a reason for hiding this comment

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

Yes, unfortunately. I did not go through all of the tests, so there may be more in SR that need to be addressed.

component.update();
});

component.update();

expect(exists('saveRepositoryApiError')).toBe(true);
expect(find('saveRepositoryApiError').text()).toContain(error.message);
});
Expand All @@ -261,31 +478,32 @@ describe('<RepositoryAdd />', () => {
describe('source only', () => {
beforeEach(() => {
// Fill step 1 required fields and go to step 2
testBed.form.setInputValue('nameInput', repository.name);
testBed.actions.selectRepositoryType(repository.type);
testBed.form.setInputValue('nameInput', fsRepository.name);
testBed.actions.selectRepositoryType(fsRepository.type);
testBed.form.toggleEuiSwitch('sourceOnlyToggle'); // toggle source
testBed.actions.clickNextButton();
});

test('should send the correct payload', async () => {
const { form, actions } = testBed;
const { form, actions, component } = testBed;

// Fill step 2
form.setInputValue('locationInput', repository.settings.location);
form.setInputValue('locationInput', fsRepository.settings.location);

await act(async () => {
actions.clickSubmitButton();
await nextTick();
});

component.update();

const latestRequest = server.requests[server.requests.length - 1];

expect(JSON.parse(JSON.parse(latestRequest.requestBody).body)).toEqual({
name: repository.name,
name: fsRepository.name,
type: 'source',
settings: {
delegateType: repository.type,
location: repository.settings.location,
delegateType: fsRepository.type,
location: fsRepository.settings.location,
},
});
});
Expand Down
Loading