@digital-ai/devops-page-object-release 0.0.10 → 0.0.12

package/dist/types.d.ts

@@ -1,136 +1,9 @@
 import { Page, Locator, APIResponse } from "@playwright/test";
 import { APIRequestContext } from "playwright-core";
-interface BaseConfigurationItem {
-    id: string;
-    type: string;
-}
-interface PlanItem extends BaseConfigurationItem {
-    title: string;
-}
-interface Release extends PlanItem {
-    allowConcurrentReleasesFromTrigger: boolean;
-    attachments: Array<Attachment>;
-    description: string;
-    dueDate?: Date;
-    endDate?: Date;
-    extensions: Array<ReleaseExtension>;
-    owner?: string;
-    passwordVariableValues?: VariableValues;
-    phases: Array<Phase>;
-    queryableEndDate?: Date;
-    queryableStartDate?: Date;
-    scheduledStartDate?: Date;
-    scriptUserPassword?: string;
-    scriptUsername?: string;
-    startDate?: Date;
-    status: ReleaseStatus;
-    summary?: Dashboard;
-    teams: Array<Team>;
-    variableValues?: VariableValues;
-    variables: Array<Variable>;
-}
-interface VariableValues {
-    [key: string]: any;
-}
-interface Variable extends BaseConfigurationItem {
-    key: string;
-    requiresValue: boolean;
-    showOnReleaseStart: boolean;
-    value: any;
-    valueProvider?: VariableValueProvider;
-}
-interface VariableValueProvider {
-    id: string;
-    variable: string;
-}
-interface Container extends PlanItem {
-    tasks: Array<Task>;
-}
-interface Phase extends Container {
-    status: PhaseStatus;
-}
-interface Task extends PlanItem {
-    attachments: Array<Attachment>;
-    comments: Array<Comment>;
-    conditions: Array<Condition>;
-    dependencies: Array<Dependency>;
-    links: Array<Link>;
-    owner?: string;
-    precondition: string;
-    pythonScript?: PythonScript;
-    script: string;
-    status: TaskStatus;
-    tasks: Array<Task>;
-    templateVariables: Array<Variable>;
-}
-type Condition = PlanItem;
-type Dependency = PlanItem;
-type Link = PlanItem;
-type Comment = PlanItem;
-type Attachment = PlanItem;
-interface Dashboard extends ReleaseExtension {
-    tiles: Array<Tile>;
-}
-type ReleaseExtension = BaseConfigurationItem;
-type Tile = BaseConfigurationItem;
-interface PythonScript extends BaseConfigurationItem {
-    customScriptTask: string;
-}
-type ReleaseStatus = 'TEMPLATE' | 'PLANNED' | 'IN_PROGRESS' | 'PAUSED' | 'FAILING' | 'FAILED' | 'COMPLETED' | 'ABORTED';
-type PhaseStatus = 'PLANNED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILING' | 'FAILED' | 'SKIPPED' | 'ABORTED';
-type TaskStatus = 'IN_PROGRESS' | 'PLANNED' | 'SKIPPED_IN_ADVANCE' | 'COMPLETED_IN_ADVANCE' | 'COMPLETED' | 'SKIPPED' | 'ABORTED' | 'PENDING' | 'FACET_CHECK_IN_PROGRESS' | 'FAILED' | 'FAILING' | 'FAILURE_HANDLER_IN_PROGRESS' | 'ABORT_SCRIPT_IN_PROGRESS' | 'PRECONDITION_IN_PROGRESS' | 'QUEUED' | 'ABORT_SCRIPT_QUEUED' | 'WAITING_FOR_INPUT' | 'FAILURE_HANDLER_QUEUED';
-type Team = BaseConfigurationItem;
-type FeatureCategory = 'Stable' | 'Incubating';
-type FeatureType = 'xlrelease.TaskDrawer';
-interface FixtureFeature {
-    category: FeatureCategory;
-    enabled: boolean;
-    id: string;
-    type: FeatureType;
-}
-type DeepPartial<T> = {
-    [P in keyof T]?: DeepPartial<T[P]>;
-};
-type FixtureRelease = DeepPartial<Release> & Pick<Release, 'id'>;
-interface FixtureConfiguration extends PlanItem {
-    apiToken?: string;
-    password?: string;
-    url: string;
-    username?: string;
-}
-interface FixtureTrigger extends PlanItem {
-    folderId?: string;
-    gitRepository?: string;
-    periodicity?: number | string;
-    pollType?: string;
-    releaseTitle: string;
-    template: string;
-}
 declare class WithPage {
     protected readonly page: Page;
     constructor(page: Page);
 }
-declare class LoginPage extends WithPage {
-    /**
-     * Login with username and password
-     * @param userName
-     * @param password
-     */
-    login(userName: string, password: string): Promise<void>;
-    /**
-     * Logout as authenticated user
-     */
-    logout(): Promise<void>;
-    /**
-     * Expect login to be restricted for a user
-     */
-    expectLoginDisallowed(): Promise<void>;
-    /**
-     * Expect the respective user is logged In
-     * @param username
-     */
-    expectToBeLogged(username: string): Promise<void>;
-}
 declare class ReleasesListPage extends WithPage {
     expectNumberOfReleases(releaseTitle: string, amount: number): Promise<void>;
     openReleaseByName(releaseTitle: string): Promise<ReleasePage>;
@@ -172,8 +45,24 @@ declare class ConditionRail extends WithPage {
     disablePrecondition(): Promise<void>;
     setPrecondition(script: string): Promise<void>;
 }
+declare class OverviewRail extends WithPage {
+    railLocator: Locator;
+    constructor(page: Page);
+    setValueFromMap(propertyName: string, key: string, value: string): Promise<void>;
+    setScript(script: string): Promise<void>;
+    expectScriptToContain(script: string): Promise<void>;
+    abort(comment: string): Promise<void>;
+}
+declare class ActivityRail extends WithPage {
+    expectCommentToContain(text: string): Promise<void>;
+}
+declare class AttachmentRail extends WithPage {
+    expectWithAttachment(filename: string): Promise<void>;
+}
 type Rail = 'Overview' | 'Activity' | 'Config' | 'Scheduling' | 'Conditions' | 'Attributes' | 'Attach' | 'Tags';
 declare class TaskDrawer extends WithPage {
+    activity: ActivityRail;
+    attachment: AttachmentRail;
     config: ConfigRail;
     condition: ConditionRail;
     taskDrawerLocator: Locator;
@@ -181,6 +70,7 @@ declare class TaskDrawer extends WithPage {
     cancelButton: Locator;
     commentBox: Locator;
     confirm: Locator;
+    overview: OverviewRail;
     skipMenu: Locator;
     constructor(page: Page);
     openOverviewRail(): Promise<void>;
@@ -195,13 +85,25 @@ declare class TaskDrawer extends WithPage {
     retryTask(comment: string): Promise<void>;
     skipTask(comment: string): Promise<void>;
 }
+declare class ReleasePropertiesPage extends WithPage {
+    constructor(page: Page);
+    editReleaseName(name: string): Promise<void>;
+    setDescription(description: string): Promise<void>;
+    setScriptUsername(username: string): Promise<void>;
+    setScriptUserPassword(password: string): Promise<void>;
+    save(): Promise<void>;
+    reset(): Promise<void>;
+}
 declare class ReleasePage extends WithPage {
     taskDrawer: TaskDrawer;
+    properties: ReleasePropertiesPage;
+    variables: ReleaseVariablesPage;
     constructor(page: Page);
     openTriggers(): Promise<TriggersPage>;
     abort(comment?: string): Promise<void>;
-    getPhase(phaseName: string): _Phase1;
+    getPhase(phaseName: string): Phase;
     start(): Promise<void>;
+    waitForCompletion(timeout: number): Promise<void>;
     waitForTaskCompleted(taskTitle: string): Promise<void>;
     waitForTaskFailed(taskTitle: string): Promise<void>;
     waitForTaskSkipped(taskTitle: string): Promise<void>;
@@ -209,15 +111,26 @@ declare class ReleasePage extends WithPage {
     waitForStatusLine(statusLine: string): Promise<void>;
     waitForTaskStarted(taskTitle: string): Promise<void>;
     openTaskDrawer(taskName: string): Promise<TaskDrawer>;
-    openVariables(): Promise<ReleaseVariablesPage>;
-    openReleaseMenu(menuItem: string): Promise<void>;
+    openVariables(): Promise<void>;
+    openProperties(): Promise<void>;
+    openReleaseFlow(): Promise<void>;
+    openRelationships(): Promise<void>;
+    openTeamsPermissions(): Promise<void>;
+    openDashboard(): Promise<void>;
+    openActivityLogs(): Promise<void>;
     openTask(taskName: string): Promise<void>;
     collapseAllTaskView(): Promise<void>;
     expandAllTaskView(): Promise<void>;
+    backToRelease(): Promise<void>;
 }
-declare class _Phase1 extends WithPage {
+declare class Phase extends WithPage {
     constructor(page: Page, phaseName: string);
-    addTask(taskName: string, taskGroup: string, taskType: string): Promise<void>;
+    setTitle(title: string): Promise<void>;
+    expectTaskBorderWithColor(taskName: string, color: string): Promise<void>;
+    addTaskInPhase(taskTitle: string, taskType: any): Promise<void>;
+    getNumberOfTasks(): Promise<number>;
+    expectToHaveNoneditableTitle(phaseTitle: string): Promise<void>;
+    expectToHaveTitle(phaseTitle: string): Promise<void>;
 }
 declare class ApplicationsPage extends WithPage {
     goToApplicationsPage(): Promise<this>;
@@ -277,6 +190,17 @@ declare class ReleaseCalendarPage extends WithPage {
     cancelCalendarExport(): Promise<number>;
     verifyDayView(): Promise<void>;
     verifyYearView(): Promise<void>;
+    verifyMonthView(): Promise<void>;
+    verifyPageContent(title: string): Promise<void>;
+    filterReleaseByTitle(title: string): Promise<void>;
+    filterReleaseByTags(tags: string[], release_title: string): Promise<void>;
+    filterTaskByTags(tags: string[], task_title: string, release_title: string): Promise<void>;
+    filterReleaseByStatus(release_status: string, release_title: string): Promise<void>;
+    filterReleaseByRisk(release_risk: string, release_title: string): Promise<void>;
+    filterFlaggedRelease(release_title: string): Promise<void>;
+    viewRelease(release_title: string, release_id: string): Promise<void>;
+    viewDependency(source_release: string, dest_release: string): Promise<void>;
+    downloadIcsCalendar(release_title: string): Promise<number>;
 }
 declare class Navigation {
     releasePage: ReleasePage;
@@ -285,6 +209,7 @@ declare class Navigation {
     applicationPage: ApplicationsPage;
     taskDetailsPage: TaskDetails;
     releaseCalendarPage: ReleaseCalendarPage;
+    releaseListPage: ReleasesListPage;
     constructor(page: Page);
     openTemplate(id: string): Promise<ReleasePage>;
     openRelease(id: string): Promise<ReleasePage>;
@@ -307,6 +232,135 @@ declare class Navigation {
     gotoGobalVariablesPage(): Promise<void>;
     gotoConnectionsPage(): Promise<void>;
 }
+declare class LoginPage extends WithPage {
+    /**
+     * Login with username and password
+     * @param userName
+     * @param password
+     */
+    login(userName: string, password: string): Promise<void>;
+    /**
+     * Logout as authenticated user
+     */
+    logout(): Promise<void>;
+    /**
+     * Expect login to be restricted for a user
+     */
+    expectLoginDisallowed(): Promise<void>;
+    /**
+     * Expect the respective user is logged In
+     * @param username
+     */
+    expectToBeLogged(username: string): Promise<void>;
+}
+interface BaseConfigurationItem {
+    id: string;
+    type: string;
+}
+interface PlanItem extends BaseConfigurationItem {
+    title: string;
+}
+interface Release extends PlanItem {
+    allowConcurrentReleasesFromTrigger: boolean;
+    attachments: Array<Attachment>;
+    description: string;
+    dueDate?: Date;
+    endDate?: Date;
+    extensions: Array<ReleaseExtension>;
+    owner?: string;
+    passwordVariableValues?: VariableValues;
+    phases: Array<_Phase1>;
+    queryableEndDate?: Date;
+    queryableStartDate?: Date;
+    scheduledStartDate?: Date;
+    scriptUserPassword?: string;
+    scriptUsername?: string;
+    startDate?: Date;
+    status: ReleaseStatus;
+    summary?: Dashboard;
+    teams: Array<Team>;
+    variableValues?: VariableValues;
+    variables: Array<Variable>;
+}
+type VariableValues = Record<string, any>;
+interface Variable extends BaseConfigurationItem {
+    key: string;
+    requiresValue: boolean;
+    showOnReleaseStart: boolean;
+    value: string;
+    valueProvider?: VariableValueProvider;
+}
+interface VariableValueProvider {
+    id: string;
+    variable: string;
+}
+interface Container extends PlanItem {
+    tasks: Array<Task>;
+}
+interface _Phase1 extends Container {
+    status: PhaseStatus;
+}
+interface Task extends PlanItem {
+    attachments: Array<Attachment>;
+    comments: Array<Comment>;
+    conditions: Array<Condition>;
+    dependencies: Array<Dependency>;
+    links: Array<Link>;
+    owner?: string;
+    precondition: string;
+    pythonScript?: PythonScript;
+    script: string;
+    status: TaskStatus;
+    tasks: Array<Task>;
+    templateVariables: Array<Variable>;
+}
+type Condition = PlanItem;
+type Dependency = PlanItem;
+type Link = PlanItem;
+type Comment = PlanItem;
+type Attachment = PlanItem;
+interface Dashboard extends ReleaseExtension {
+    tiles: Array<Tile>;
+}
+type ReleaseExtension = BaseConfigurationItem;
+type Tile = BaseConfigurationItem;
+interface PythonScript extends BaseConfigurationItem {
+    customScriptTask: string;
+}
+type ReleaseStatus = 'TEMPLATE' | 'PLANNED' | 'IN_PROGRESS' | 'PAUSED' | 'FAILING' | 'FAILED' | 'COMPLETED' | 'ABORTED';
+type PhaseStatus = 'PLANNED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILING' | 'FAILED' | 'SKIPPED' | 'ABORTED';
+type TaskStatus = 'IN_PROGRESS' | 'PLANNED' | 'SKIPPED_IN_ADVANCE' | 'COMPLETED_IN_ADVANCE' | 'COMPLETED' | 'SKIPPED' | 'ABORTED' | 'PENDING' | 'FACET_CHECK_IN_PROGRESS' | 'FAILED' | 'FAILING' | 'FAILURE_HANDLER_IN_PROGRESS' | 'ABORT_SCRIPT_IN_PROGRESS' | 'PRECONDITION_IN_PROGRESS' | 'QUEUED' | 'ABORT_SCRIPT_QUEUED' | 'WAITING_FOR_INPUT' | 'FAILURE_HANDLER_QUEUED';
+type Team = BaseConfigurationItem;
+type FeatureType = 'xlrelease.TaskDrawer';
+interface FixtureFeature {
+    enabled: boolean;
+    id: string;
+    type: FeatureType;
+}
+type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+type FixtureRelease = DeepPartial<Release> & Pick<Release, 'id'>;
+interface FixtureConfiguration extends PlanItem {
+    apiToken?: string;
+    password?: string;
+    url: string;
+    username?: string;
+}
+interface FixtureTrigger extends PlanItem {
+    folderId?: string;
+    gitRepository?: string;
+    periodicity?: number | string;
+    pollType?: string;
+    releaseTitle: string;
+    template: string;
+}
+interface FixtureActivityLog extends PlanItem {
+    activityType: string;
+    eventTime: Date;
+    message: string;
+    username: string;
+}
 type ReleaseFixtures = {
     fixtures: Fixtures;
     loginPage: LoginPage;
@@ -320,20 +374,26 @@ declare class Fixtures {
     trigger(trigger: FixtureTrigger): Promise<APIResponse>;
     deleteArchivedRelease(id: string): Promise<APIResponse>;
     deleteRelease(id: string): Promise<APIResponse>;
+    deleteUser(username: string): Promise<APIResponse>;
+    deleteUserProfile(userProfile: string): Promise<APIResponse>;
     deleteTrigger(id: string): Promise<APIResponse>;
     deleteConfiguration(id: string): Promise<APIResponse>;
-    cleanAll(): Promise<Awaited<APIResponse>[]>;
+    activityLogs(releaseId: string, logs: Array<FixtureActivityLog>): Promise<APIResponse>;
+    cleanAll(): Promise<void>;
+    addJiraTask(): Promise<string>;
+    addUser(username: string, password: string): Promise<void>;
+    addUserProfile(username: string, profile?: any): Promise<void>;
+    expectJiraTaskStatus(taskId: string, expectedStatus: string): Promise<void>;
+    expectJiraTaskSummary(taskId: string, expectedSummary: string): Promise<void>;
     waitForReleaseStarted(releaseTitle: string): Promise<void>;
     waitForFirstPoll(triggerId: string): Promise<void>;
     exec(path: string): Promise<void>;
     getFakeApiUrl(): string;
     getEnvVariable(name: string): string | undefined;
+    archiveRelease(releaseId: string): Promise<APIResponse>;
+    preArchiveRelease(releaseId: string): Promise<APIResponse>;
     setFeatures(features: Array<FixtureFeature>): Promise<APIResponse>;
     enableTaskDrawer(enabled: boolean): Promise<APIResponse>;
-    addUser(username: string, password: string): Promise<APIResponse>;
-    addUserProfile(username: string, profile: any): Promise<APIResponse>;
-    deleteUser(username: string): Promise<APIResponse>;
-    deleteUserProfile(username: string): Promise<APIResponse>;
 }
 
 //# sourceMappingURL=types.d.ts.map