Project

General

Profile

Actions

action #10380

closed

Improve documentation on assert_screen as well as extend test developer guidelines

Added by okurz about 8 years ago. Updated about 7 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
-
Start date:
2016-01-22
Due date:
% Done:

0%

Estimated time:

Description

motivation

see https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/960/files#r50528991

baseline

https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/945#issue-127701894

@RBrownSUSE I think after your recent changes and as you already wrote the guideline in your PR it makes sense to update the documentation and test develper guidelines accordingly so that we all better understand the reasoning and best practices. Should be simple to do.


Related issues 1 (0 open1 closed)

Related to openQA Project - action #10522: Generate and publish documentation regarding os-autoinst AND openQA properly togetherResolvedszarate2016-02-01

Actions
Actions #1

Updated by oholecek about 8 years ago

  • Assignee set to oholecek

I already have almost all testapi calls documented. I'll do another self-review and prepare PR. The part what is yet missing is script which will collect testapi POD and update WritingTests.asciidoc section in openQA.

Actions #2

Updated by okurz about 8 years ago

nice, maybe also review other documents referencing this, e.g. https://github.com/os-autoinst/openQA/blob/master/docs/Pitfalls.asciidoc

Actions #3

Updated by okurz about 8 years ago

https://github.com/os-autoinst/openQA/blob/master/docs/WritingTests.asciidoc should be updated, e.g. the examples reference "assert_screen" with explicit timeout where we want to use the default. The only example where it makes sense is the

assert_screen "desktop", 300;

for obvious reasons

Actions #4

Updated by dmaiocchi about 8 years ago

aaanz, so i'm interested too make the write_test documentation for openqa. Basically i want to share what i have done, and experimented.

So we can syncronize us to make not double work.

1- i would like to make a table for commands instead list of commands.
2 - i would like to document some variables that influence the main.pm
3 - i would like to make more structure/layout on the page, maybe split the page in advanced/basic.

Actions #5

Updated by okurz over 7 years ago

  • Related to action #10522: Generate and publish documentation regarding os-autoinst AND openQA properly together added
Actions #6

Updated by okurz over 7 years ago

oholecek, can you say what's the current status on this one?

Actions #7

Updated by okurz about 7 years ago

  • Status changed from New to In Progress
  • Assignee changed from oholecek to okurz

ok, I get it, you don't care about your progress tickets.

Actions #9

Updated by okurz about 7 years ago

both PR merged, doc for openQA updated, e.g. see https://github.com/os-autoinst/openQA/blob/master/docs/WritingTests.asciidoc

But http://open.qa/api/testapi/#_assert_screen is not yet updated, why?

Actions #10

Updated by okurz about 7 years ago

  • Status changed from In Progress to Resolved

the documentation not being up-to-date is #10522, shouldn't block this one here

Actions

Also available in: Atom PDF