-
Notifications
You must be signed in to change notification settings - Fork 915
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.
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
[Manual Backport 2.x]Fix missing customApiRegistryPromise param for test connection (#5944) #5971
Merged
ZilongX
merged 3 commits into
opensearch-project:2.x
from
BionIT:backport/backport-5944-to-2.x
Feb 27, 2024
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
96 changes: 96 additions & 0 deletions
96
src/plugins/data_source/server/routes/test_connection.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,96 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
import supertest from 'supertest'; | ||
import { UnwrapPromise } from '@osd/utility-types'; | ||
import { setupServer } from '../../../../../src/core/server/test_utils'; | ||
|
||
import { | ||
IAuthenticationMethodRegistery, | ||
authenticationMethodRegisteryMock, | ||
} from '../auth_registry'; | ||
import { CustomApiSchemaRegistry } from '../schema_registry'; | ||
import { DataSourceServiceSetup } from '../../server/data_source_service'; | ||
import { CryptographyServiceSetup } from '../cryptography_service'; | ||
import { registerTestConnectionRoute } from './test_connection'; | ||
import { AuthType } from '../../common/data_sources'; | ||
// eslint-disable-next-line @osd/eslint/no-restricted-paths | ||
import { opensearchClientMock } from '../../../../../src/core/server/opensearch/client/mocks'; | ||
|
||
type SetupServerReturn = UnwrapPromise<ReturnType<typeof setupServer>>; | ||
|
||
const URL = '/internal/data-source-management/validate'; | ||
|
||
describe(`Test connection ${URL}`, () => { | ||
let server: SetupServerReturn['server']; | ||
let httpSetup: SetupServerReturn['httpSetup']; | ||
let handlerContext: SetupServerReturn['handlerContext']; | ||
let cryptographyMock: jest.Mocked<CryptographyServiceSetup>; | ||
const customApiSchemaRegistry = new CustomApiSchemaRegistry(); | ||
let customApiSchemaRegistryPromise: Promise<CustomApiSchemaRegistry>; | ||
let dataSourceClient: ReturnType<typeof opensearchClientMock.createInternalClient>; | ||
let dataSourceServiceSetupMock: DataSourceServiceSetup; | ||
let authRegistryPromiseMock: Promise<IAuthenticationMethodRegistery>; | ||
const dataSourceAttr = { | ||
endpoint: 'https://test.com', | ||
auth: { | ||
type: AuthType.UsernamePasswordType, | ||
credentials: { | ||
username: 'testUser', | ||
password: 'testPassword', | ||
}, | ||
}, | ||
}; | ||
|
||
beforeEach(async () => { | ||
({ server, httpSetup, handlerContext } = await setupServer()); | ||
customApiSchemaRegistryPromise = Promise.resolve(customApiSchemaRegistry); | ||
authRegistryPromiseMock = Promise.resolve(authenticationMethodRegisteryMock.create()); | ||
dataSourceClient = opensearchClientMock.createInternalClient(); | ||
|
||
dataSourceServiceSetupMock = { | ||
getDataSourceClient: jest.fn(() => Promise.resolve(dataSourceClient)), | ||
getDataSourceLegacyClient: jest.fn(), | ||
}; | ||
|
||
const router = httpSetup.createRouter(''); | ||
dataSourceClient.info.mockImplementationOnce(() => | ||
opensearchClientMock.createSuccessTransportRequestPromise({ cluster_name: 'testCluster' }) | ||
); | ||
registerTestConnectionRoute( | ||
router, | ||
dataSourceServiceSetupMock, | ||
cryptographyMock, | ||
authRegistryPromiseMock, | ||
customApiSchemaRegistryPromise | ||
); | ||
|
||
await server.start(); | ||
}); | ||
|
||
afterEach(async () => { | ||
await server.stop(); | ||
}); | ||
|
||
it('shows successful response', async () => { | ||
const result = await supertest(httpSetup.server.listener) | ||
.post(URL) | ||
.send({ | ||
id: 'testId', | ||
dataSourceAttr, | ||
}) | ||
.expect(200); | ||
expect(result.body).toEqual({ success: true }); | ||
expect(dataSourceServiceSetupMock.getDataSourceClient).toHaveBeenCalledWith( | ||
expect.objectContaining({ | ||
savedObjects: handlerContext.savedObjects.client, | ||
cryptography: cryptographyMock, | ||
dataSourceId: 'testId', | ||
testClientDataSourceAttr: dataSourceAttr, | ||
customApiSchemaRegistryPromise, | ||
}) | ||
); | ||
}); | ||
}); |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems like that you include the others changes here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't include it, but it is hanging here since it was left alone from the auto backport https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5823/files, and original PR has the changelog https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5619/files
If I remove it, it will not be in 2.x but it should. How should we handle it? @bandinib-amzn @ashwin-pc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to Backport workflow, we skip changelog for backport PR. That's why we don't see changelog in autocut backport. I'm not sure if we use changelog from 2.x branch.
So for this PR, I would suggest keep only your changes in
CHANGELOG.md
.@ashwin-pc Can you tell us what is best practice for changelog when we manually backport PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the dangling changelog for now