-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
36 changed files
with
740 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,9 @@ | |
}, | ||
"lastReported": { | ||
"type": "date" | ||
}, | ||
"lastVersionChecked": { | ||
"type": "keyword" | ||
} | ||
} | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
184 changes: 184 additions & 0 deletions
184
src/legacy/core_plugins/telemetry/server/replace_injected_vars/get_telemetry_opt_in.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import { getTelemetryOptIn } from './get_telemetry_opt_in'; | ||
import { TelemetrySavedObject } from './get_telemetry_saved_object'; | ||
|
||
describe('getTelemetryOptIn', () => { | ||
it('returns false when request path is not /app*', () => { | ||
const params = getCallGetTelemetryOptInParams({ | ||
requestPath: '/foo/bar', | ||
}); | ||
|
||
const result = callGetTelemetryOptIn(params); | ||
|
||
expect(result).toBe(false); | ||
}); | ||
|
||
it('returns null when saved object not found', () => { | ||
const params = getCallGetTelemetryOptInParams({ | ||
savedObjectNotFound: true, | ||
}); | ||
|
||
const result = callGetTelemetryOptIn(params); | ||
|
||
expect(result).toBe(null); | ||
}); | ||
|
||
it('returns false when saved object forbidden', () => { | ||
const params = getCallGetTelemetryOptInParams({ | ||
savedObjectForbidden: true, | ||
}); | ||
|
||
const result = callGetTelemetryOptIn(params); | ||
|
||
expect(result).toBe(false); | ||
}); | ||
|
||
it('returns null if enabled is null or undefined', () => { | ||
for (const enabled of [null, undefined]) { | ||
const params = getCallGetTelemetryOptInParams({ | ||
enabled, | ||
}); | ||
|
||
const result = callGetTelemetryOptIn(params); | ||
|
||
expect(result).toBe(null); | ||
} | ||
}); | ||
|
||
it('returns true when enabled is true', () => { | ||
const params = getCallGetTelemetryOptInParams({ | ||
enabled: true, | ||
}); | ||
|
||
const result = callGetTelemetryOptIn(params); | ||
|
||
expect(result).toBe(true); | ||
}); | ||
|
||
// build a table of tests with version checks, with results for enabled false | ||
type VersionCheckTable = Array<Partial<CallGetTelemetryOptInParams>>; | ||
|
||
const EnabledFalseVersionChecks: VersionCheckTable = [ | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '8.0.0', result: false }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '8.0.1', result: false }, | ||
{ lastVersionChecked: '8.0.1', currentKibanaVersion: '8.0.0', result: false }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '8.1.0', result: null }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '9.0.0', result: null }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '7.0.0', result: false }, | ||
{ lastVersionChecked: '8.1.0', currentKibanaVersion: '8.0.0', result: false }, | ||
{ lastVersionChecked: '8.0.0-X', currentKibanaVersion: '8.0.0', result: false }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: '8.0.0-X', result: false }, | ||
{ lastVersionChecked: null, currentKibanaVersion: '8.0.0', result: null }, | ||
{ lastVersionChecked: undefined, currentKibanaVersion: '8.0.0', result: null }, | ||
{ lastVersionChecked: 5, currentKibanaVersion: '8.0.0', result: null }, | ||
{ lastVersionChecked: '8.0.0', currentKibanaVersion: 'beta', result: null }, | ||
{ lastVersionChecked: 'beta', currentKibanaVersion: '8.0.0', result: null }, | ||
{ lastVersionChecked: 'beta', currentKibanaVersion: 'beta', result: false }, | ||
{ lastVersionChecked: 'BETA', currentKibanaVersion: 'beta', result: null }, | ||
].map(el => ({ ...el, enabled: false })); | ||
|
||
// build a table of tests with version checks, with results for enabled true/null/undefined | ||
const EnabledTrueVersionChecks: VersionCheckTable = EnabledFalseVersionChecks.map(el => ({ | ||
...el, | ||
enabled: true, | ||
result: true, | ||
})); | ||
|
||
const EnabledNullVersionChecks: VersionCheckTable = EnabledFalseVersionChecks.map(el => ({ | ||
...el, | ||
enabled: null, | ||
result: null, | ||
})); | ||
|
||
const EnabledUndefinedVersionChecks: VersionCheckTable = EnabledFalseVersionChecks.map(el => ({ | ||
...el, | ||
enabled: undefined, | ||
result: null, | ||
})); | ||
|
||
const AllVersionChecks = [ | ||
...EnabledFalseVersionChecks, | ||
...EnabledTrueVersionChecks, | ||
...EnabledNullVersionChecks, | ||
...EnabledUndefinedVersionChecks, | ||
]; | ||
|
||
test.each(AllVersionChecks)( | ||
'returns expected result for version check with %j', | ||
async (params: Partial<CallGetTelemetryOptInParams>) => { | ||
const result = await callGetTelemetryOptIn({ ...DefaultParams, ...params }); | ||
expect(result).toBe(params.result); | ||
} | ||
); | ||
}); | ||
|
||
interface CallGetTelemetryOptInParams { | ||
requestPath: string; | ||
savedObjectNotFound: boolean; | ||
savedObjectForbidden: boolean; | ||
enabled: boolean | null | undefined; | ||
lastVersionChecked?: any; // should be a string, but test with non-strings | ||
currentKibanaVersion: string; | ||
result?: boolean | null; | ||
} | ||
|
||
const DefaultParams = { | ||
requestPath: '/app/something', | ||
savedObjectNotFound: false, | ||
savedObjectForbidden: false, | ||
enabled: true, | ||
lastVersionChecked: '8.0.0', | ||
currentKibanaVersion: '8.0.0', | ||
}; | ||
|
||
function getCallGetTelemetryOptInParams( | ||
overrides: Partial<CallGetTelemetryOptInParams> | ||
): CallGetTelemetryOptInParams { | ||
return { ...DefaultParams, ...overrides }; | ||
} | ||
|
||
function callGetTelemetryOptIn(params: CallGetTelemetryOptInParams) { | ||
const { currentKibanaVersion } = params; | ||
const request = getMockRequest(params); | ||
const telemetrySavedObject = getMockTelemetrySavedObject(params); | ||
return getTelemetryOptIn({ request, currentKibanaVersion, telemetrySavedObject }); | ||
} | ||
|
||
function getMockTelemetrySavedObject(params: CallGetTelemetryOptInParams): TelemetrySavedObject { | ||
const { savedObjectNotFound, savedObjectForbidden } = params; | ||
if (savedObjectForbidden) { | ||
return false; | ||
} | ||
if (savedObjectNotFound) { | ||
return null; | ||
} | ||
|
||
return { | ||
enabled: params.enabled, | ||
lastVersionChecked: params.lastVersionChecked, | ||
}; | ||
} | ||
|
||
function getMockRequest(params: CallGetTelemetryOptInParams): any { | ||
return { | ||
path: params.requestPath, | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.