feat(connect-form): add kerberos authentication #2718
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,134 @@ | ||
| import React from 'react'; | ||
| import { render, screen, fireEvent } from '@testing-library/react'; | ||
| import { expect } from 'chai'; | ||
| import sinon from 'sinon'; | ||
| import ConnectionStringUrl from 'mongodb-connection-string-url'; | ||
|
|
||
| import AuthenticationGssapi from './authentication-gssapi'; | ||
| import { ConnectionFormError } from '../../../utils/validation'; | ||
| import { UpdateConnectionFormField } from '../../../hooks/use-connect-form'; | ||
|
|
||
| function renderComponent({ | ||
| errors = [], | ||
| connectionStringUrl = new ConnectionStringUrl('mongodb://localhost:27017'), | ||
| updateConnectionFormField, | ||
| }: { | ||
| connectionStringUrl?: ConnectionStringUrl; | ||
| errors?: ConnectionFormError[]; | ||
| updateConnectionFormField: UpdateConnectionFormField; | ||
| }) { | ||
| render( | ||
| <AuthenticationGssapi | ||
| errors={errors} | ||
| connectionStringUrl={connectionStringUrl} | ||
| updateConnectionFormField={updateConnectionFormField} | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| describe('AuthenticationGssapi Component', function () { | ||
| let updateConnectionFormFieldSpy: sinon.SinonSpy; | ||
| beforeEach(function () { | ||
| updateConnectionFormFieldSpy = sinon.spy(); | ||
| }); | ||
|
|
||
| describe('when the kerberosPrincipal input is changed', function () { | ||
| beforeEach(function () { | ||
| renderComponent({ | ||
| updateConnectionFormField: updateConnectionFormFieldSpy, | ||
| }); | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(0); | ||
|
|
||
| fireEvent.change(screen.getByLabelText('Principal'), { | ||
| target: { value: 'good sandwich' }, | ||
| }); | ||
| }); | ||
|
|
||
| it('calls to update the form field', function () { | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(1); | ||
| expect(updateConnectionFormFieldSpy.firstCall.args[0]).to.deep.equal({ | ||
| type: 'update-username', | ||
| username: 'good sandwich', | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when the serviceName input is changed', function () { | ||
| beforeEach(function () { | ||
| renderComponent({ | ||
| updateConnectionFormField: updateConnectionFormFieldSpy, | ||
| }); | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(0); | ||
|
|
||
| fireEvent.change(screen.getByLabelText('Service Name'), { | ||
| target: { value: 'good sandwich' }, | ||
| }); | ||
| }); | ||
|
|
||
| it('calls to update the form field', function () { | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(1); | ||
| expect(updateConnectionFormFieldSpy.firstCall.args[0]).to.deep.equal({ | ||
| key: 'SERVICE_NAME', | ||
| type: 'update-auth-mechanism-property', | ||
| value: 'good sandwich', | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when the serviceRealm input is changed', function () { | ||
| beforeEach(function () { | ||
| renderComponent({ | ||
| updateConnectionFormField: updateConnectionFormFieldSpy, | ||
| }); | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(0); | ||
|
|
||
| fireEvent.change(screen.getByLabelText('Service Realm'), { | ||
| target: { value: 'good sandwich' }, | ||
| }); | ||
| }); | ||
|
|
||
| it('calls to update the form field', function () { | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(1); | ||
| expect(updateConnectionFormFieldSpy.firstCall.args[0]).to.deep.equal({ | ||
| key: 'SERVICE_REALM', | ||
| type: 'update-auth-mechanism-property', | ||
| value: 'good sandwich', | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when the canoncalize hostname is changed', function () { | ||
| beforeEach(function () { | ||
| renderComponent({ | ||
| updateConnectionFormField: updateConnectionFormFieldSpy, | ||
| }); | ||
|
|
||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(0); | ||
| const checkbox = screen.getByLabelText('Canonicalize Host Name'); | ||
| fireEvent.click(checkbox); | ||
| }); | ||
|
|
||
| it('calls to update the form field', function () { | ||
| expect(updateConnectionFormFieldSpy.callCount).to.equal(1); | ||
| expect(updateConnectionFormFieldSpy.firstCall.args[0]).to.deep.equal({ | ||
| key: 'CANONICALIZE_HOST_NAME', | ||
| type: 'update-auth-mechanism-property', | ||
| value: 'true', | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| it('renders an error when there is a kerberosPrincipal error', function () { | ||
| renderComponent({ | ||
| errors: [ | ||
| { | ||
| fieldName: 'kerberosPrincipal', | ||
| message: 'kerberosPrincipal error', | ||
| }, | ||
| ], | ||
| updateConnectionFormField: updateConnectionFormFieldSpy, | ||
| }); | ||
|
|
||
| expect(screen.getByText('kerberosPrincipal error')).to.be.visible; | ||
| }); | ||
| }); |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,9 +1,105 @@ | ||
| import React from 'react'; | ||
| import { Checkbox, TextInput } from '@mongodb-js/compass-components'; | ||
|
|
||
| import ConnectionStringUrl from 'mongodb-connection-string-url'; | ||
| import { UpdateConnectionFormField } from '../../../hooks/use-connect-form'; | ||
| import FormFieldContainer from '../../form-field-container'; | ||
| import { | ||
| ConnectionFormError, | ||
| errorMessageByFieldName, | ||
| } from '../../../utils/validation'; | ||
| import { | ||
| getConnectionStringUsername, | ||
| parseAuthMechanismProperties, | ||
| } from '../../../utils/connection-string-helpers'; | ||
|
|
||
| function AuthenticationGSSAPI({ | ||
| errors, | ||
| connectionStringUrl, | ||
| updateConnectionFormField, | ||
| }: { | ||
| connectionStringUrl: ConnectionStringUrl; | ||
| errors: ConnectionFormError[]; | ||
| updateConnectionFormField: UpdateConnectionFormField; | ||
| }): React.ReactElement { | ||
| const kerberosPrincipalError = errorMessageByFieldName( | ||
| errors, | ||
| 'kerberosPrincipal' | ||
| ); | ||
| const principal = getConnectionStringUsername(connectionStringUrl); | ||
| const authMechanismProperties = | ||
| parseAuthMechanismProperties(connectionStringUrl); | ||
| const serviceName = authMechanismProperties.get('SERVICE_NAME'); | ||
| const serviceRealm = authMechanismProperties.get('SERVICE_REALM'); | ||
| const canonicalizeHostname = authMechanismProperties.get( | ||
| 'CANONICALIZE_HOST_NAME' | ||
| ); | ||
|
|
||
| return ( | ||
| <> | ||
| <FormFieldContainer> | ||
| <TextInput | ||
| onChange={({ | ||
| target: { value }, | ||
| }: React.ChangeEvent<HTMLInputElement>) => { | ||
| updateConnectionFormField({ | ||
| type: 'update-username', | ||
| username: value, | ||
| }); | ||
| }} | ||
| label="Principal" | ||
| errorMessage={kerberosPrincipalError} | ||
| state={kerberosPrincipalError ? 'error' : undefined} | ||
| value={principal || ''} | ||
|
There was a problem hiding this comment. Previously we had an info link to https://docs.mongodb.com/manual/core/kerberos/#principals There was a problem hiding this comment. Ah that's a good one, yeah, i'll merge this and add it right away |
||
| /> | ||
| </FormFieldContainer> | ||
|
|
||
| <FormFieldContainer> | ||
| <TextInput | ||
| onChange={({ | ||
| target: { value }, | ||
| }: React.ChangeEvent<HTMLInputElement>) => { | ||
| updateConnectionFormField({ | ||
| type: 'update-auth-mechanism-property', | ||
| key: 'SERVICE_NAME', | ||
| value: value, | ||
| }); | ||
| }} | ||
| label="Service Name" | ||
| value={serviceName || ''} | ||
| /> | ||
| </FormFieldContainer> | ||
|
|
||
| <FormFieldContainer> | ||
| <Checkbox | ||
| onChange={(event: React.ChangeEvent<HTMLInputElement>) => { | ||
| updateConnectionFormField({ | ||
| type: 'update-auth-mechanism-property', | ||
| key: 'CANONICALIZE_HOST_NAME', | ||
| value: event.target.checked ? 'true' : '', | ||
| }); | ||
| }} | ||
| label="Canonicalize Host Name" | ||
| checked={canonicalizeHostname === 'true'} | ||
| bold={false} | ||
| /> | ||
| </FormFieldContainer> | ||
|
|
||
| <FormFieldContainer> | ||
| <TextInput | ||
| onChange={({ | ||
| target: { value }, | ||
| }: React.ChangeEvent<HTMLInputElement>) => { | ||
| updateConnectionFormField({ | ||
| type: 'update-auth-mechanism-property', | ||
| key: 'SERVICE_REALM', | ||
| value: value, | ||
| }); | ||
| }} | ||
| label="Service Realm" | ||
| value={serviceRealm || ''} | ||
| /> | ||
| </FormFieldContainer> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
This file contains hidden or 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 hidden or 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 hidden or 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.
🙌