search

owncloud / QA

:collision: public test plans for owncloud components and apps
GNU Affero General Public License v3.0
14 stars 14 forks source link

[QA] Maintain Consistency for example table header name #829

Closed grgprarup closed 8 months ago

grgprarup commented 1 year ago

It would be better to maintain the consistency for naming example table headers throughout the feature files.

We are using different case styles and names for header names in the example tables.

For an example: dav_version, dav-path-version, and dav-path were used for DAV path version like old, new, and spaces. dav_path was used for DAV path like /webdav, /dav, and /dav/spaces. those were refactored with PR https://github.com/owncloud/ocis/pull/6697, and dav-path-version used for DAV path version.

Again, in PR https://github.com/owncloud/ocis/pull/6552 dav_version was used for DAV path version. And, in PR https://github.com/owncloud/ocis/pull/6958 dav-path was used for DAV path

In PR (https://github.com/owncloud/ocis/pull/6697) the refactoring was done only for dav version and path, there are more other cases where consistency can be maintained (ocs-api-version, ocs_api_version, http_status_code, http-status, http-status-code etc. are some, we can check for more)

For discussion:

CC @individual-it @phil-davis @ScharfViktor @saw-jan

saw-jan commented 1 year ago

To prevent it from happening again, we could add table column check. We already have the implementation for that.

individual-it commented 1 year ago

I would suggest to use kebab (dav-path) casing

ScharfViktor commented 1 year ago

Usually we use copy paste. to prevent using different casing -> we should leave ONLY one in the code dav-path sounds good

grgprarup commented 8 months ago

For uniformity and to avoid creating different variables which might create confusion when reading feature files here are some changes to be done and follow:

  1. Use a consistent header name for the same use case. Here are some examples, there are more cases. So, before you add example tables please check for existing name used for similar cases.
    • http-status-code for status code of HTTP and ocs-status-code for status code of OCS
    • dav-path-version for the dav path version and dav-path for webdav path
    • user-role for roles (Admin, Space Admin, User, User Light etc.)
    • space-role for roles of project space (manager, editor, viewer etc.)
    • role for resource share role (editor, viewer etc.)
    • permissions-role for roles of resource permissions in sharing NG (Viewer, File Editor, Editor, Uploader, Space Editor, Space Viewer etc.)
  2. Use a kebab case style for header name
grgprarup commented 8 months ago

Refactoring of header name for examples table is done for oCIS test suites and all the related PR are merged. So, closing this issue.