Bug 1158464

Summary:	rlFileBackup should be visible doesn't appear in the test log
Product:	[Fedora] Fedora	Reporter:	Karel Srot <ksrot>
Component:	beakerlib	Assignee:	Dalibor Pospíšil <dapospis>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Fedora Extras Quality Assurance <extras-qa>
Severity:	low	Docs Contact:
Priority:	medium
Version:	20	CC:	dapospis, pmuller, psplicha
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	beakerlib-1.10-1	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2014-12-12 14:48:00 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1136360, 1136362

Description Karel Srot 2014-10-29 12:51:52 UTC

Description of problem:

From the test log/output it is not clear that there was a rlFileBackup and rlFileRestore called. The test log doesn't mention it at all.

Is it supposed to be executed inside rlRun? Because current man page doesn't mention it. It if people are using it it that way could visually _break_ the log.

Also, beside seeing the function call+arguments it would be useful to be able to see the location where backed up files are being stored (/var/tmp/beakerlib-*/backup).
Sometime the test is terminated during the execution (due to some error in the test) and since my files are already modified it would be nice to know the location where I can fetch the original versions.

Comment 1 Dalibor Pospíšil 2014-10-29 15:24:11 UTC

The function it self does its job silently unless there is some problem. It returns some exit code on which the result can be checked e.g. using rlRun.

After fixing bz554280 the situation could be better so simple rlRun would make even more sense then.

I have to agree that the documentation could describe exit codes more precisely and maybe the example could involve rlRun.

The function can be called manytimes so printing the backup path all the time could be annoying. I would go for one-time message if this is really required.

Comment 2 Karel Srot 2014-10-29 16:33:17 UTC

(In reply to Dalibor Pospíšil from comment #1)
> The function it self does its job silently unless there is some problem. It
> returns some exit code on which the result can be checked e.g. using rlRun.

OK. If using rlRun is the preferred option I would propose to reflect that in the man page (including the example there). 

> 
> After fixing bz554280 the situation could be better so simple rlRun would
> make even more sense then.
> 
> I have to agree that the documentation could describe exit codes more
> precisely and maybe the example could involve rlRun.
> 
> The function can be called manytimes so printing the backup path all the
> time could be annoying. I would go for one-time message if this is really
> required.

I don't think that printing one line (the top level directory used for the backup) would be annoying, especially given that the command doesn't print any other output.
Also, since multiple name spaces could be used knowing the correct backup directory would be even more useful.

Comment 3 Dalibor Pospíšil 2014-10-30 15:50:07 UTC

fixed by https://git.fedorahosted.org/cgit/beakerlib.git/commit/?id=a5884d423f8c7bec333617b98873f9d3c333782a and https://git.fedorahosted.org/cgit/beakerlib.git/commit/?id=7d4458e7c715287e81be8206117da1f6a9444781

Comment 4 Karel Srot 2014-10-30 16:12:53 UTC

Thanks a lot!