coremedia-globallink-connect-integration

Translation integration via GlobalLink Connect Cloud

Project maintained by CoreMedia Hosted on GitHub Pages — Theme by mattgraham

Manual Test Steps

[Up] [Top]

General

Prepare
General Advice for Manual Test Steps Within CoreMedia Studio

Scenarios

Contract Test
Happy Path
General Error Handling
Cancelation
Wrong Or Invalid Connector Key Recovery
GCC Backend Error Handling (Submission Error State)
XLIFF Import Error Handling
Redelivered State Handling

Prepare

Adjust GlobalLink-Settings within settings document at /Settings/Options/Settings/Translation Services/GlobalLink for quicker feedback during manual test-steps as well as to access the relevant sandbox via corresponding credentials:

globalLink:
  # [... other settings]
  # key (type: String)
  # Adjust either for automatic or manual GCC processing. To ease
  # switching keys, hold them in the prepared extra Struct
  # at `additionalConfigurationOptions.exampleKeys` for an easy copy & paste:
  key: "..."
  # apiKey (type: String)
  # Only used for testing. Otherwise, expected to be set via Spring for
  # security reasons.
  apiKey: "..."
  # type (type: String)
  # Adjust to "default" for processing at GCC backend or "mock" for manual
  # processing. See also: `additionalConfigurationOptions.availableTypes`.
  type: "default"
  # isSendSubmitter (type: Boolean)
  # Adjust to `true` to send the submitter with the request.
  isSendSubmitter: false
  # Section: Timing Adjustments — Get Faster Feedback on Manual Test Steps
  # Despite `retryCommunicationErrors`, which just needs to be adjusted,
  # find copy & paste ready values for the other settings in the
  # `additionalConfigurationOptions` Struct.
  sendTranslationRequestRetryDelay: 60
  downloadTranslationRetryDelay: 60
  cancelTranslationRetryDelay: 60
  retryCommunicationErrors: 1
  # Section: Submission Instruction Type Settings
  submissionInstruction:
    # [...]
    # characterType (type: String)
    # Adjust to "unicode" to provoke errors in the GCC backend, as it does
    # not support SMP characters.
    characterType: "unicode"
  submissionName:
    # [...]
    # characterType (type: String)
    # Adjust to "unicode" to provoke errors in the GCC backend, as it does
    # not support SMP characters.
    characterType: "unicode"
  # Section: Mock Settings
  # Referenced below, like to provoke errors are certain states.
  mock:
    # [...]

General Advice for Manual Test Steps Within CoreMedia Studio

Settings as Favorite:

It is recommended to add the settings document /Settings/Options/Settings/Translation Services/GlobalLink to the “Favorites” in Studio. It is required to be adapted multiple times during the manual test steps.
Start Workflow Options:

There are various ways to start localization workflows. Choose one of them during your test-steps and possibly switch to others for further steps. Some available options are:
- Drag an article into the “Localization Workflows” drop area in Control Room.
- Choose “Start Translation Workflow” within the Locale Switcher of an opened document.
Workflow Interaction Options:

Just as for when starting the workflow, you have multiple ways to interact with the workflow. Choose one of them during your test-steps and possibly switch to others for further steps. Some available options are:
- In Localization Nagbar: To directly switch from a document to its assigned localization workflow, click on one of the available options in the nagbar, which is either clicking the link, to jump to the Workflow App or click on the button, to open the workflow within a sidebar.
- Control Room: Provides an overview of running workflows and allows you to interact with them.
- Workflow App: Provides a more detailed view of the workflow.
- Workflow Sidebar: Opened within the Content App, providing an overview of the workflow.
Studio Localization:

It is good practice, to switch the language of the Studio UI from time to time, to ensure also German labels are available.

Test Matrix Template

The following table can be copied, to track your test results. Copy it to a suitable application (like your approval task issue, for example) and fill it with your results.

Scenario	Connector Type	Key Type
Contract Test	`default`	`automatic`
Happy Path	`default`	`automatic`
General Error Handling	`default`	`automatic`
Cancelation (Studio)	`default`	`manual`
Cancelation (GlobalLink)	`default`	`manual`
Cancelation (Error Handling)	`default`	`manual`
Wrong/Invalid Connector Key	`default`	`manual`
GCC Backend Error Handling	`mock`	irrelevant
XLIFF Import Error Handling	`mock`	irrelevant
Redelivered State Handling	`mock`	irrelevant

Scenario: Contract Test

Especially on updates of gcc-restclient you should run the half-automatic test DefaultGCExchangeFacadeContractTest. Read the JavaDoc to know how to configure and run the test.

Lately, when using the automatic workflow, the submission is not marked as DELIVERED anymore. This is why the translateXliff test fails. It seems to work with the manual workflow though.

Set Up

To run the test you need to create a file with the name .gcc.properties in your user home folder

Manual Review

Please review the following aspects in the management dashboard of GlobalLink manually (all submissions created by this test should have a name starting with CT and a timestamp).

Instructions

The test shouldRespectInstructions should have created submissions with so-called “submission instructions” (in the workflow: “Notes”) for these scenarios (by ID):

BMP (refers to Base Multilingual Plane)

It is expected that each described character is represented visually as described within the test fixture. Thus, arrows should be visible as arrows and even high level Unicode character from BMP should be displayed correctly (e.g., the “Fullwidth Exclamation Mark”: ！).
FORMAT (refers to newlines and tabs)

As instructions in the GCC backend are expected to be HTML, the newlines should be replaced by <br> and tabs by   . In other words: You should see visible line-breaks and indents.
HTML_AS_TEXT

Given the assumption, that in the Workflow App the instructions are given in plain-text, the HTML should be escaped. Thus, you should see no bold text, no newline triggered by a textual <br>, and also entities like & should be visible as plain-text.
UNICODE_SMP (SMP refers to the Supplementary Multilingual Plane)

For now, the GCC backend is expected to not support SMP characters. Thus, corresponding characters like emojis (dove, for example: 🕊) should be replaced by a placeholder pattern. Current implementation is, to make them distinguishable, that the placeholder is the Unicode code point in hex, such as U+1F54A.

Submitter

The test shouldRespectSubmitter should have created submissions with overridden submitter names (thus, must be different to the account username). Three submissions should be visible:

YES: The submitter name should be the test’s name.
NO: The submitter name should be the account username.
DEFAULT: The submitter name should be the account username.

Scenario: Happy Path

Connector Type: default
Key Type: automatic

Quick Steps

Log in as Rick C.
Use globalLink.type=default and the “automatic” connector key.
Link two articles A → B.
Start a translation workflow for the article A.
Validate the start workflow window to show no issues and to have a due date set 20 days from now.
Start the workflow.
In the Workflow App, see how information are continuously updated, like the state, the submission ID, and the completed locales.
Wait until the user-task “Review delivered translation” is offered to you.
Validate that the target articles have received an updated (pseudo-)translation.

Detailed Steps

User Rick: Log in as Rick C.

Adjust Settings: Settings to adjust/verify in /Settings/Options/Settings/Translation Services/GlobalLink:

globalLink:
  key: "<automatic workflow connector key>"
  apiKey: "..."
  type: "default"
  dayOffsetForDueDate: 20
  isSendSubmitter: true
  # Adjusted retry settings, see above for details.
  # [...]

Article A: Create an article A and remove validation issues.
Article B:Create an article B and remove validation issues.
A → B: Create a link from the article A to the article B.
Start Workflow Window: Trigger starting the workflow and validate the default values:
1. No Issues: There should be no warnings or errors
2. Due Date: Field Due Date should be set to the current date/time plus 20 days
3. Dependent Content: Article B should be added as dependent content.
4. Notes: Add some text to the field Notes.
Start Workflow: Click “Start”
1. The dialog should close without any error
2. A nagbar should appear in the document form, stating that the documents are being translated.
Workflow App: Navigate to the workflow details within the Workflow App.
Workflow Details (In Progress): In the workflow’s detail view, validate:
1. After some time, Status, Submission ID, and Due Date should be shown.
2. As long as the workflow is in “Running”, field “Completed Locales” should display “0 Locales”.
Workflow Details (Done, Review): Later in the workflow’s detail view, validate:
1. The “Status” field should display “Delivered”
2. The “Completed Locales” field should display the target locales of the workflow
3. When clicking on the translated content, it should open in language comparison view in CoreMedia Studio.
4. The text is expected to be pseudo-translated (behavior provided by the GCC backend).
Finish Workflow: In the Workflow App, click “Accept Task”, “Next Step”, “Finish Content Localization”, and “Yes, continue”
1. The workflow should disappear from “Open”
2. The workflow should appear in “Closed”

In addition to the above steps and in addition to the results from the contract test, you may want to review in GCC Management Dashboard:

That Rick C is set as the submitter for the submission.
That the notes are visible in the submission (as instructions).

Scenario: General Error Handling

Connector Type: default
Key Type: automatic

Log in as Rick C.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to default
2. Credentials for gcc are entered (manual workflow key)
Break it: Change the apiKey to something wrong, for example, add a - (minus) to the beginning.
Start a translation workflow for an article.
Wait for the workflow to appear in Workflow App’s “Open” workflows
1. The icon should be a warning sign
2. The “Current Task” in Workflow App’s detail view should be “Upload Error”
Click “Accept Task” and “Next Step”
1. You have the ability to “Abort and rollback changes” or “Continue and retry”
2. A click on “Abort and rollback changes” should perform a rollback of the content (if you perform that you need to redo steps above)
Set apiKey in GlobalLink settings to its valid value and click “Continue and retry”
Open the workflow’s details in the Workflow App and wait for this state before you continue:
1. The status should change to “Translate”.
2. The “Submission ID” should be set.
Set apiKey in GlobalLink settings to something wrong again.
Wait for the task to change to “Download Error”.
Accept the task.
1. Validate available options when pressing “Next” are:
  1. Abort and rollback changes
  2. Continue and retry
Select “Abort and rollback changes” (which will subsequently try to trigger a cancelation at GlobalLink).
Wait for the current task to change to “Cancelation Error”.
1. The icon should signal a warning.
Accept the task.
1. Validate available options when pressing “Next” are:
  1. Abort and rollback without canceling at GlobalLink
  2. Retry cancelation
  3. Continue translation
Set apiKey in GlobalLink settings to its valid value.
Choose “Continue translation”
The workflow should end without errors and appear in Closed.

Scenario: Cancelation

Connector Type: default
Key Type: manual

Cancelation in Studio

Log in as Rick C.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to default
2. Credentials for gcc are entered (manual workflow key)
Start a translation for an article.
Select the started translation in the control-room.
Click the “X” in the header bar and confirm the dialog.
Open the “Closed” area in the Workflow App.
Wait for the translation process to appear in “Closed”.
Check:
1. The “Status” field should display “Canceled”
2. The icon should mark the workflow as canceled (little “x” on the bottom right)

Cancelation in GlobalLink

Log in as Rick C.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to default
2. Credentials for gcc are entered (manual workflow key)
Start a translation for an article.

It is recommended to set a distinguishable name for the workflow, to better locate in the next step.
Log in to the GlobalLink Management Dashboard and cancel the workflow.

The “Cancel” button used to be in the upper right corner of the opened submission.
Go back to the Workflow App
1. After a while, the workflow should appear in Rick’s “Open” workflows
2. When accepting the task, Rick can only choose to abort and rollback the previous changes and accept the cancelation.
3. Choose “Abort and rollback changes”.
Open the “Closed” area and open the canceled workflow.
1. Field “Status” should display “Canceled”
2. The icon should mark the workflow as canceled (little “x” on the bottom right)

Cancelation Error Handling

The following test is about the error handling of a cancelation, as well as it includes testing UI behaviors for multi-selection.

Log in as Rick C.

Required to use Rick C here, as Adam, for example, will not be able to do the multi-selection test, as local translations will appear in “Open” section for Adam.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to default
2. Credentials for gcc are entered (manual workflow key)
Start three translation workflows for the same article:
1. Start a GlobalLink Translation Workflow two times.
2. Start a default Blueprint translation workflow.
Control Room: Check the multi-selection behavior of the “X” in the header bar:
1. If all selected translations are of type “GlobalLink”, the “X” should be visible and activated.
2. If one of the selected translations is not of type “GlobalLink”, the “X” should be hidden.
Workflow App: Check the “X Cancel” option in the “Running” section of the Workflow App:
1. If all selected translations are of type “GlobalLink”, the “X” should be visible and activated.
2. If one of the selected translations is not of type “GlobalLink”, the “X” should be hidden.
Break it:

Consider to temporarily change the globalLink.retryCommunicationErrors to 2 to give you more time (120 seconds) to proceed with the next steps.

Prepare to change, for example globalLink.apiKey to some invalid value like adding a - (minus) as first character. This will cause subsequent calls to GlobalLink to fail.

Before that, either have your control-room open, or the workflow app in an extra window. For a single-screen setup, it is recommended to use the control-room.

Do it: Now, break the connection to GlobalLink by changing the apiKey.
Speed Mode, Step 1: Select both “Translation with GlobalLink” workflows and click the “X”. Acknowledge the dialog to proceed the cancelation.
Speed Mode, Step 2: Check that already now, the “X” button/menu-entry is disabled.

You may calm down now, as the following steps are not time-critical.
Workflow App: Open one of the workflows.
Wait for the workflow to reach the task named “Cancelation error”.
Validate the following:
1. The “Current Task” field should display “Cancelation Error”.
2. The “Status” field should display “Canceled”.
3. The icon should signal a warning.
Click “Accept Task” and “Next Step”
1. Validate options, that should be available:
  1. Abort and rollback without canceling at GlobalLink
  2. Retry cancelation
  3. Continue translation
2. Click “Abort and rollback without canceling at GlobalLink” and open the target site’s document
  1. The document should remain in its previous version.
3. Go back to the Workflow App overview
  1. The workflow should be moved from the “Running” to the “Closed” list
  2. The “Status” field in Workflow App’s overview should display “Workflow completed”
  3. The icon should mark the workflow as canceled (little “x” on the bottom right)

Scenario: Wrong Or Invalid Connector Key Recovery

This test is about a robustness layer introduced with 2406.1 approval: If during a running translation workflow you change the connector key (stored as globalLink.key) to another (but valid connector key), the workflow should be able to recover from that scenario ones the key is valid again. Also, if the key is invalid, the workflow should be able to recover from that scenario.

Connector Type: default
Key Type: manual (initially)

Quick Steps

Log in as Rick C.
Use default type, and the “manual” connector key.
Start a translation of an article and wait for the submission ID to be retrieved.
Change the connector key to “automatic”.
See that error-handling-task is reached with an issue about an unknown submission.
Change the connector key to an invalid key.
Trigger retry.
See that error-handling-task is reached with an issue about an invalid connector key.
Set the connector key back to “manual”.
Trigger retry.
The workflow should continue polling the translation state without issues.

Detailed Steps

Log in as Rick C.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to default
2. Credentials for gcc are entered (manual workflow key)
Start a translation for a given article.
To Workflow App: Navigate, for example via the nagbar, to the Workflow App and wait until the workflow is in the “Translate” state (Current task: “Awaiting translation results”).
Content App: Change the connector key to another valid key (thus, “automatic”).
Workflow App: Wait until the current task changes to “Download Error”.
Accept the task.
Content App: Change the connector key to an invalid key, for example, prefix it with an additional 0.
Workflow App: Click “Next Step”. Validate an error is shown about an unknown submission, triggered by our previous misconfiguration.
Choose “Continue and retry”.
Wait until the current task changes to “Download Error” again.
Accept the task.
Content App: Change the connector key back to our initial, valid key (thus, “manual”).
Workflow App: Click “Next Step”. Validate an error is shown about an invalid connector key, triggered by our previous misconfiguration.
Choose “Continue and retry”.
The workflow should continue polling the translation state without issues.

Scenario: GCC Backend Error Handling (Submission Error State)

This test is about submissions within the GCC backend, which are in an error state. This has been observed, for example, when trying to send a submission with instructions containing characters from the Supplementary Multilingual Plane (SMP).

Alternative Scenario: The given manual test steps “mock” this state, as we cannot ensure that an error persists over time. If you want to test the real-life behavior, you may choose using the “default” rather than the “mock” type and instead of using mock.error, you may use the submissionInstruction.characterType setting. Set it to unicode and add some SMP characters to the instructions (thus, workflow notes), like for example, the dove emoji: 🕊.

Advantage: The advantage of the real-world scenario is, that you may also test, that a submission in an error state may still be canceled.

Connector Type: mock
Key Type: irrelevant

Quick Steps

Log in as Rick C.
Use mock type.
Set mock.error to SUBMISSION_ERROR. For a quick path, you may skip the extra submission state mocking as sketched in the detailed steps.
Start a translation of an article.
Open the started workflow process.
Expect a user-task “Download error” and accept it.
Validate that a localized error message like “General submission failure” is shown.

Detailed Steps

Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink

type is set to mock
mock.error is set to SUBMISSION_ERROR

Submission State Mocking: Add (or activate) the following mock settings (optional step, but recommended to test closer to the real-world scenario):

mock:
  # [...]
  submissionStates:
    Started:
      override: Pre-Process
      # Mark as final to ease mocking here. Prevents further states,
      # though, which is, that you also cannot cancel the submission
      # in this mocked scenario.
      final: true

Start a translation for an article.
Open the workflow in Workflow App via nagbar shown in the article.
Wait until the current task is “Download error” and offered to you.
Accept the task.
Click the error issue information and see a “General submission failure.”

In the real-world scenario, you may now continue like to “Abort and rollback changes” as most likely, the submission cannot be repaired. This is not possible in this simple mocked scenario, though.

Scenario: XLIFF Import Error Handling

Connector Type: mock
Key Type: irrelevant

Log in as Rick C.
Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink
1. type is set to mock
2. mock.error is set to DOWNLOAD_XLIFF
Start a translation for an article.
Wait for the workflow to appear in Workflow App’s “Open” workflows
1. The icon should be a warning sign
Open the workflow details:
1. Field “Current Task” should be “Download error”
2. In the section “More”, a download link for the broken XLIFF should be shown under “Issue Details”
Click the XLIFF download link
1. Both the XLIFF and an issue details text file should be included
Click “Accept Task” and “Next Step”
1. You should have the ability to “Abort and rollback changes” or “Continue and retry”

Scenario: Redelivered State Handling

Connector Type: mock
Key Type: irrelevant

It has been observed, that, if the XLIFF is broken, it is not necessarily fixed within the GCC backend. Instead, the workflow is marked as “Redelivered”, and the XLIFF is provided by different means, such as sent via email.

The following steps simulate this scenario:

Open the GlobalLink settings /Settings/Options/Settings/Translation Services/GlobalLink

type is set to mock
Set retryCommunicationErrors to 0 (assumed to ease state mocking)
mock.error is set to DOWNLOAD_XLIFF

Submission State Mocking: Add (or activate) the following mock settings:

mock:
  # [...]
  submissionStates:
    Completed:
      # Directly after "Completed" state, the submission is marked as
      # "Redelivered".
      after:
        # We need to duplicate the state, as otherwise you may observe
        # the "Review Redelivered Translation" task, to be triggered
        # directly after "Completed" and not, after we got into the
        # error handling task.
        - Completed
        - Redelivered
      # Mark the state as final, not to continue with the next
      # (standard) state.
      final: true

Side Note For now, we accept the duplicate state. We may want to review, though, if processing (or mocking) can be optimized here.

Start a translation for an article.
Wait for the workflow to appear in Workflow App’s “Open” workflows
Double-click the workflow
1. Field “Current Task” should be “Review Translation (redelivered)”
2. Status should be “Redelivered”
3. In the section “More”, a download link for the broken XLIFF should be shown under “Issue Details” (if you skipped setting mock.error the field is not available).
Click the XLIFF download link
1. Both the XLIFF and an issue details text file should be included
In the Workflow App, click “Accept Task”, “Next Step”, “Finish Content Localization”, and “Yes, continue”
1. The workflow should disappear from “Open”
2. The workflow should appear in “Closed”

Consider Cleanup

If you have time and want to do it: In Project Director you may multi-select submissions, cancel them and subsequently archive them. This way, the overview at least in Project Director is kept clean.

[Up] [Top]

coremedia-globallink-connect-integration

Manual Test Steps

Contents

General

Scenarios

Prepare

General Advice for Manual Test Steps Within CoreMedia Studio

Test Matrix Template

Scenario: Contract Test

Set Up

Manual Review

Instructions

Submitter

Scenario: Happy Path

Quick Steps

Detailed Steps

Scenario: General Error Handling

Scenario: Cancelation

Cancelation in Studio

Cancelation in GlobalLink

Cancelation Error Handling

Scenario: Wrong Or Invalid Connector Key Recovery

Quick Steps

Detailed Steps

Scenario: GCC Backend Error Handling (Submission Error State)

Quick Steps

Detailed Steps

Scenario: XLIFF Import Error Handling

Scenario: Redelivered State Handling

Consider Cleanup