feat: Add authentication option to markdown-confluence-sync. Run E2E tests to check the whole feature

Author: javierbrea

.github/workflows/test-e2e.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - feat/56/custom-auth-methods
 
 permissions:
   contents: read

components/markdown-confluence-sync/markdown-confluence-sync.config.cjs

@@ -31,7 +31,11 @@ module.exports = {
   ],
   confluence: {
     url: process.env.CONFLUENCE_URL,
-    personalAccessToken: process.env.CONFLUENCE_PAT,
+    authentication: {
+      oauth2: {
+        accessToken: process.env.CONFLUENCE_PAT,
+      },
+    },
     spaceKey: process.env.CONFLUENCE_SPACE_KEY,
     rootPageId: process.env.CONFLUENCE_ROOT_PAGE_ID,
     rootPageName: "Cross",

components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts

@@ -32,6 +32,8 @@ import type {
   UrlOptionDefinition,
   NoticeTemplateOptionDefinition,
   NoticeTemplateOption,
+  AuthenticationOptionDefinition,
+  AuthenticationOption,
 } from "./ConfluenceSync.types.js";
 import { ConfluencePageTransformer } from "./transformer/ConfluencePageTransformer.js";
 import type { ConfluencePageTransformerInterface } from "./transformer/ConfluencePageTransformer.types.js";
@@ -78,6 +80,11 @@ const dryRunOption: DryRunOptionDefinition = {
   default: false,
 };
 
+const authenticationOption: AuthenticationOptionDefinition = {
+  name: "authentication",
+  type: "object",
+};
+
 export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   implements ConfluenceSyncInterface
 {
@@ -90,6 +97,7 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   private _rootPageNameOption: RootPageNameOption;
   private _noticeMessageOption: NoticeMessageOption;
   private _noticeTemplateOption: NoticeTemplateOption;
+  private _authenticationOption: AuthenticationOption;
   private _dryRunOption: DryRunOption;
   private _initialized = false;
   private _logger: LoggerInterface;
@@ -113,6 +121,9 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
     this._noticeTemplateOption = config.addOption(
       noticeTemplateOption,
     ) as NoticeTemplateOption;
+    this._authenticationOption = config.addOption(
+      authenticationOption,
+    ) as AuthenticationOption;
     this._dryRunOption = config.addOption(dryRunOption) as DryRunOption;
     this._modeOption = mode;
     this._logger = logger;
@@ -182,6 +193,7 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
       this._confluenceSyncPages = new ConfluenceSyncPages({
         url: this._urlOption.value,
         personalAccessToken: this._personalAccessTokenOption.value,
+        authentication: this._authenticationOption.value,
         spaceId: this._spaceKeyOption.value,
         rootPageId: this._rootPageIdOption.value,
         logLevel: this._logger.level,

components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.types.ts

@@ -7,7 +7,10 @@ import type {
   OptionDefinition,
 } from "@mocks-server/config";
 import type { LoggerInterface } from "@mocks-server/logger";
-import type { ConfluenceInputPage } from "@telefonica/confluence-sync";
+import type {
+  ConfluenceInputPage,
+  ConfluenceClientAuthenticationConfig,
+} from "@telefonica/confluence-sync";
 
 import type { ModeOption } from "../MarkdownConfluenceSync.types";
 
@@ -27,8 +30,13 @@ declare global {
       confluence?: {
         /** Confluence URL */
         url?: UrlOptionValue;
-        /** Confluence personal access token */
+        /**
+         * Confluence personal access token
+         * @deprecated Use authentication.oauth2.accessToken instead
+         **/
         personalAccessToken?: PersonalAccessTokenOptionValue;
+        /** Confluence authentication */
+        authentication?: ConfluenceClientAuthenticationConfig;
         /** Confluence space key */
         spaceKey?: SpaceKeyOptionValue;
         /** Confluence root page id */
@@ -63,6 +71,11 @@ export type DryRunOptionDefinition = OptionDefinition<
   { hasDefault: true }
 >;
 
+export type AuthenticationOptionDefinition =
+  OptionDefinition<ConfluenceClientAuthenticationConfig>;
+
+export type AuthenticationOption =
+  OptionInterfaceOfType<ConfluenceClientAuthenticationConfig>;
 export type UrlOption = OptionInterfaceOfType<UrlOptionValue>;
 export type PersonalAccessTokenOption =
   OptionInterfaceOfType<PersonalAccessTokenOptionValue>;