Naming Convention Best Practices for Automation Entities

Adopting a consistent and meaningful naming convention is crucial for effective codeless automation in ACCELQ. A well-thought-out naming strategy enhances the readability, understanding, and maintainability of your test entities. Follow these best practices for naming test elements:

• Be Natural and Meaningful: Choose names that are clear, concise, and align with your organization's standards. Meaningful names facilitate easy comprehension of test entities.
• Focus on "What," Not "How": Emphasize the purpose or action of the entity, rather than the technical implementation details. This ensures that the names remain relevant and adaptable to changes in the application.
• Avoid Ambiguity: Provide complete and descriptive names to eliminate ambiguity. Utilize spaces to enhance clarity and readability.

Action Naming

An Action is an encapsulation of a block of logic that accomplishes a step in a Scenario.

• Good Examples:

  • "Verify Post Enrollment Steps"
  • "Login to Connect Source"
  • "Create New Task"

• Bad Examples:

  • "Post Enrollment Steps"
  • "Enter Username"
  • "Creating New Task"

  Good Action names focus on the action being performed and are expressed as meaningful command verbs. Avoid generic or incomplete names like "Post Enrollment Steps" and "Enter Username."

Context Naming

A Context generally represents a page in your application (for Web Automation).

• Good Example:
  • "Case Details Page"
• Bad Example:
  • "Details Page"

A good name, like "Case Details Page," provides specific context and avoids ambiguity, making it easier to identify the purpose of the Context.

Scenario Naming

A Scenario represents a business process you are automating.

• Good Example:

  • "Verify Enrollment for a New Registrant"

• Bad Example:

  • "Check Enrollment"

A well-formed Scenario name clearly describes the business process being tested, while a vague name like "Check Enrollment" lacks specificity and context.

Test Case Naming

A Test Case is a data permutation instance of a given Scenario as part of data-driven testing.

• Good Examples, for a Scenario: "Verify Hospital Checkin":

  • "Existing Patient"
  • "New Patient"

• Bad Example:

  • "Test Case 1"

Use descriptive names that identify the data variation addressed in the Test Case. Avoid generic names with numerical indexes like "Test Case 1."

Test Suite Naming

Test Suite is a collection of Scenarios that are executed as a batch, for the purposes of meeting testing objectives.

• Good Example:

  • "Sanity Suite for Case Creation"

• Bad Examples:

  • "Flights Module,"

  • "Sanity Suite 1"

A good Test Suite name indicates its purpose and scope, such as "Sanity Suite for Case Creation." Avoid ambiguous names like "Flights Module" and generic numerical indexes like "Sanity Suite 1."

By applying these examples and adhering to a meaningful naming convention, your ACCELQ automation project will become more organized, user-friendly, and conducive to collaboration among team members. Well-named test entities enhance overall test automation efficiency and contribute to the success of your testing initiatives.