First pass on getting all documentation related tests in order.

docs_audience.feature
Titles of some terms changed in audience vocabulary, updated the feature to match (http://drupalcode.org/project/doobie.git/commit/7af2d39).

I don't think we need 6 tests for the same thing. We could go with just one which
- checks that all terms are present on the /edit page
- changes just to one of the terms to see that the process works.

Furthermore, I think this file should be renamed to docs_about_page.feature
with "Feature: About this page block on documentation pages"

And it should include similar tests for other fields shown in that block: Drupal version, Level and Keywords

docs_locked.feature
I think this file needs to be renamed to docs_access.feature and include also tests for creation and edit of the doc pages. Basically first scenarios from handbook_metadata.feature file should be moved here (don't think we need so many tests for Edit, I'll see which ones can be removed later).

handbook_metadata.feature
Should be renamed to docs_metadata.feature and have only 3 last scenarios in it.

docs_management.feature
Updated description in this file. (http://drupalcode.org/project/doobie.git/commit/7af2d39)

book_page_status.feature
This file should be renamed to docs_page_status.feature
with Feature: Page status block on documentation pages
Tests from report_to_moderator.feature should be moved here.

handbook_comment_directions.feature
This file should be renamed to docs_comments.feature

log_message_check.feature
Should be renamed to docs_log_message.feature

Comments

kssundar’s picture

Assigned: Unassigned » kssundar
Issue tags: +sprint 12

Tagging and assigning

kssundar’s picture

Status: Needs review » Active

docs audience
Changes implemented and committed here - http://drupalcode.org/project/doobie.git/commit/fda149a
File renamed as suggested - http://drupalcode.org/project/doobie.git/commit/388196e

[EDIT]
Updated feature definition - http://drupalcode.org/project/doobie.git/commit/1d7932c

[EDIT]
Missed to format tables - http://drupalcode.org/project/doobie.git/commit/139877a
Will update other items one by one

kssundar’s picture

Status: Active » Needs review

1)

docs_locked.feature
I think this file needs to be renamed to docs_access.feature and include also tests for creation and edit of the doc pages. Basically first scenarios from handbook_metadata.feature file should be moved here (don't think we need so many tests for Edit, I'll see which ones can be removed later).

For this I think we should have a scenario where docs manager creates a doc and sets the input filter to "Full HTML". Then login as site user and verify that he cannot edit this. Please confirm.

2)

book_page_status.feature
This file should be renamed to docs_page_status.feature
with Feature: Page status block on documentation pages
Tests from report_to_moderator.feature should be moved here.

I thought, verifying book page status and reporting a doc to the moderator are two different functions. Should they be merged? If so, then "docs_page_status" may not be the right filename and the description also has to be changed. Please confirm.

pradeeprkara’s picture

handbook_metadata.feature
Should be renamed to docs_metadata.feature and have only 3 last scenarios in it.

Multiple edit scenarios in different user login are included in order to check the below cases and I am not sure it can be done with 3 scenarios.

  • Check edited usernames with the latest entries from revision tab, make sure it doesn't include creator username and duplicates
  • Make sure edited user list doesn't include creator username
  • Make sure edited user list doesn't have duplicates
  • Check the last updated date

The related issue is #1685112: Test documentation "edited by" line (handbook_metadata.feature)

kssundar’s picture

1)

handbook_comment_directions.feature
This file should be renamed to docs_comments.feature

committed here - http://drupalcode.org/project/doobie.git/commit/8444574


2)

log_message_check.feature
Should be renamed to docs_log_message.feature

committed here - http://drupalcode.org/project/doobie.git/commit/061c97a

tvn’s picture

Status: Active » Needs review

For this I think we should have a scenario where docs manager creates a doc and sets the input filter to "Full HTML". Then login as site user and verify that he cannot edit this. Please confirm.

Yes, good idea.

I thought, verifying book page status and reporting a doc to the moderator are two different functions. Should they be merged? If so, then "docs_page_status" may not be the right filename and the description also has to be changed. Please confirm.

Those are different functions, but my idea was to group tests (and name files) by the part of the documentation page they are testing. Sidebar has 2 blocks "Page status" and "About this page", so 2 files: docs_page_status and docs_about_page. "Report to moderator" and "Edit" links are located in the "Page status" block, so that's why I suggested to put them in that file. Makes sense? or how would you like to do it?

eliza411’s picture

The docs here may clarify grouping: http://docs.behat.org/guides/1.gherkin.html, especially

Feature: Some terse yet descriptive text of what is desired
  In order to realize a named business value
  As an explicit system actor
  I want to gain some beneficial outcome which furthers the goal

It doesn't seem like reporting a document to a moderator is at all the same value or goal as setting the status of the book page, so I wouldn't group them together. In general, I don't think that arranging files spatially is the intention of behat.

tvn’s picture

Let's leave 2 files then: docs_page_status and docs_report_to_moderator. I just didn't wanna have too many of them.

eliza411’s picture

Assigned: kssundar » tvn

It's pretty hard to track this many files in a single issue. It would be good to have tvn confirm that all the other things wrapped up in here are resolved before marking this fixed.

kssundar’s picture

Assigned: tvn » kssundar
Status: Needs review » Needs work
Issue tags: +sprint 13

Setting to needs work

eliza411’s picture

I merged all of the commits above into the 7.x branch

kssundar’s picture

Status: Needs work » Needs review

docs_locked.feature

Renamed to docs_access- http://drupalcode.org/project/doobie.git/commit/9aabf07
Updated the feature with new scenarios for checking edit permissions - http://drupalcode.org/project/doobie.git/commit/0c2ae40

book_page_status.feature
This file should be renamed to docs_page_status.feature
with Feature: Page status block on documentation pages

Updated feature definition as suggested - http://drupalcode.org/project/doobie.git/commit/6a6b829
Renamed as well - http://drupalcode.org/project/doobie.git/commit/3394f73

kssundar’s picture

All items are covered. Needs review and thoughts on comment #4

eliza411’s picture

Assigned: kssundar » tvn

Assigning to tvn directly for comment

eliza411’s picture

Issue summary: View changes

adding link to commit

tvn’s picture

Issue summary: View changes

.

tvn’s picture

Issue summary: View changes

.

tvn’s picture

Issue summary: View changes

.

tvn’s picture

Assigned: tvn » eliza411

Yeah, I'm not going to put that many files in one issue anymore :)

Re: #4 - Understood. Let's leave it as is, I just renamed the file to docs_metadata.feature.

Did small changes to other files as well (http://drupalcode.org/project/doobie.git/commit/eab83bb).
All of them look good to me now. Feel free to set to RTBC/fixed.

eliza411’s picture

Version: 6.x-1.x-dev » 7.x-1.x-dev
Assigned: eliza411 » Unassigned
Status: Needs review » Patch (to be ported)

These'll need merging into the 7.x branch. They look good on the 6.x!

kssundar’s picture

Assigned: Unassigned » kssundar
Issue tags: +sprint 14

Working on this

kssundar’s picture

Status: Patch (to be ported) » Needs review
Issue tags: +sprint 15

Updates as below:

docs_about_page.feature:
Removed colon symbol, text corrections & Added step definition to fill revision log message field - http://drupalcode.org/project/doobie.git/commit/1971123

docs_locked.feature
Renamed docs_locked to docs_access - http://drupalcode.org/project/doobie.git/commit/97d669a

The permission seems to be broken. Any document if set to Full HTML should not be edited by site user. But, in git7 site currently site user can edit. Added @known_git7failure tag.
Committed the changes here - http://drupalcode.org/project/doobie.git/commit/6f2b339
Related issue: #1824170: Documentation - Locked pages work differently? - Need to finalize on this issue and update the feature

handbook_metadata.feature
Renamed handbook_metadata to docs_metadata - http://drupalcode.org/project/doobie.git/commit/aea70f6
Committed here - http://drupalcode.org/project/doobie.git/commit/cf820a1

docs_management.feature
Minor commit here - http://drupalcode.org/project/doobie.git/commit/92db7cd
Related issues: #1823928: D7 Upgrade QA Bug: Manage Documentation - Apply button does not have a name and #1825742: Manage documentation - The select options under "Audience" have been chaged

book_page_status.feature (docs_page_status.feature)
Committed here - http://drupalcode.org/project/doobie.git/commit/d4d7d63

handbook_comment_directions.feature
Committed here - http://drupalcode.org/project/doobie.git/commit/34b0d12

log_message_check.feature
Committed here - http://drupalcode.org/project/doobie.git/commit/6db2798

docs_report_to_moderator
Unable to create an issue. Getting access denied.
Related issue: #1825746: D7 Upgrade QA Bug: Docs - Report to moderator - Getting access denied

eliza411’s picture

Status: Needs review » Fixed

docs_about_page.feature
I'm concerned that we no longer have any tests which reveal the problem in #1824218: Make 'Required log message' first foreground vertical tab

docs_management.feature
The commit at http://drupalcode.org/project/doobie.git/commit/92db7cd undoes the update in e7cfe11b3260 so I've reverted it. http://drupalcode.org/project/doobie.git/commit/267818f The rest of the updates look good.


docs_report_to_moderator

Moved to the QA queue

I'd like to see this issue closed permanently and anything still standing opened in an individual issue and cross-linked to #1824078: Documentation

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

Issue summary: View changes

.