This patch adds a test that obtains a screenshot of a domain and saves it in a file.

--- repos/domain/screenshot.py | 57 ++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 57 insertions(+), 0 deletions(-) create mode 100644 repos/domain/screenshot.py diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py new file mode 100644 index 0000000..9986cab --- /dev/null +++ b/repos/domain/screenshot.py @@ -0,0 +1,57 @@ +#!/usr/bin/env python +"""This test is used for creating a screenshot of a domain and saving + it in a file. The Screenshot format is hypervisor specific. + + mandatory arguments: guestname + screen + filename +""" + +import os +import mimetypes + +import libvirt + +def check_params(params): + """Verify input parameters""" + for key in ('guestname', 'screen', 'filename'): + if key not in params: + raise KeyError('Missing key %s required for screenshot test' % key) + + params['screen'] = int(params['screen']) + params['filename'] = os.path.abspath(params['filename']) + +def saver(stream, data, file_): + return file_.write(data) + +def screenshot(params): + """This method takes a screenshot of a running machine and saves + it in a filename""" + ret = 1

+ try: + logger = params['logger'] + + check_params(params) + + conn = libvirt.open(params['uri']) + dom = conn.lookupByName(params['guestname']) + + st = conn.newStream(0) + mime = dom.screenshot(st, params['screen'], 0) + + ext = mimetypes.guess_extension(mime) or '.ppm' + filename = params['filename'] + ext + f = file(filename, 'w') + + logger.debug('Saving screenshot into %s' % filename) + st.recvAll(saver, f) + logger.debug('Mimetype of the file is %s' % mime) + + ret = st.finish() + + finally: + # Some error occurred, cleanup + if 'conn' in locals() and conn.isAlive(): + conn.close() + + return ret

On 04/04/2012 07:13 AM, Guannan Ren wrote: > > Hi > > Currently, the testcase parser supports to cleanup testing > environment > after each testcase finished. we only need to add a flag > command 'clean' > after each testcase in testcase config, for example: > > ... > domain:screenshot > guestname > rhel6 > filename > /tmp/filescreen > screen > 0 > clean > > domain: start > guestname > ... > > > the 'clean' flag will make the framework invoke the function > named screenshot_clean > in screenshot.py. That means each testcase needs two mandatory > functions, one is the > main function, the other is main function name with '_clean' > appended. > So I send a patch for this testcase as an example. According > to the above testcase config > the '/tmp/filescreen.ppm' file will be removed after running. > There are some other flags, I need to update the documentation > sooner:) > > --- > repos/domain/screenshot.py | 5 +++++ > 1 files changed, 5 insertions(+), 0 deletions(-) > > diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py > index 9986cab..eeda2b5 100644 > --- a/repos/domain/screenshot.py > +++ b/repos/domain/screenshot.py > @@ -55,3 +55,8 @@ def screenshot(params): > conn.close() > > return ret > + > +def screenshot_clean(params): > + """clean testing environment""" > + filename = params['filename'] > + os.system('rm -f %s.*' % filename) The extension can be different every time, so we have to check that. I'd prefer something like this: diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py index 9986cab..c620085 100644 --- a/repos/domain/screenshot.py +++ b/repos/domain/screenshot.py @@ -39,8 +39,8 @@ def screenshot(params): st = conn.newStream(0) mime = dom.screenshot(st, params['screen'], 0) - ext = mimetypes.guess_extension(mime) or '.ppm' - filename = params['filename'] + ext + params['ext'] = mimetypes.guess_extension(mime) or '.ppm'

+ filename = params['filename'] + params['ext'] f = file(filename, 'w') logger.debug('Saving screenshot into %s' % filename) @@ -55,3 +55,8 @@ def screenshot(params): conn.close() return ret + +def screenshot_clean(params): + """clean testing environment""" + filename = params['filename'] + params['ext'] + os.remove(filename)

On 04/04/2012 01:23 PM, Guannan Ren wrote: > On 04/04/2012 06:30 PM, Martin Kletzander wrote: >> On 04/04/2012 07:13 AM, Guannan Ren wrote: >>> --- >>> repos/domain/screenshot.py | 5 +++++ >>> 1 files changed, 5 insertions(+), 0 deletions(-) >>> >>> diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py >>> index 9986cab..eeda2b5 100644 >>> --- a/repos/domain/screenshot.py >>> +++ b/repos/domain/screenshot.py >>> @@ -55,3 +55,8 @@ def screenshot(params): >>> conn.close() >>> >>> return ret >>> + >>> +def screenshot_clean(params): >>> + """clean testing environment""" >>> + filename = params['filename'] >>> + os.system('rm -f %s.*' % filename) >> The extension can be different every time, so we have to check that. I'd >> prefer something like this: >> >> diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py >> index 9986cab..c620085 100644 >> --- a/repos/domain/screenshot.py >> +++ b/repos/domain/screenshot.py >> @@ -39,8 +39,8 @@ def screenshot(params): >> st = conn.newStream(0) >> mime = dom.screenshot(st, params['screen'], 0) >> >> - ext = mimetypes.guess_extension(mime) or '.ppm' >> - filename = params['filename'] + ext >> + params['ext'] = mimetypes.guess_extension(mime) or '.ppm' > > This modification on params couldn't be passed in > screenshot_clean() > The params to screenshot_clean() is the same as the > screenshot() which > is from testcase config file. > > Darn :( That's exactly why I wanted the parameter passing between tests :) What do you suggest? Should I save the extension into another file or do we have any other option?

On 04/04/2012 03:10 PM, Guannan Ren wrote: > On 04/04/2012 07:53 PM, Martin Kletzander wrote: >> On 04/04/2012 01:23 PM, Guannan Ren wrote: >>> On 04/04/2012 06:30 PM, Martin Kletzander wrote: >>>> On 04/04/2012 07:13 AM, Guannan Ren wrote: >>>>> --- >>>>> repos/domain/screenshot.py | 5 +++++ >>>>> 1 files changed, 5 insertions(+), 0 deletions(-) >>>>> >>>>> diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py >>>>> index 9986cab..eeda2b5 100644 >>>>> --- a/repos/domain/screenshot.py >>>>> +++ b/repos/domain/screenshot.py >>>>> @@ -55,3 +55,8 @@ def screenshot(params): >>>>> conn.close() >>>>> >>>>> return ret >>>>> + >>>>> +def screenshot_clean(params): >>>>> + """clean testing environment""" >>>>> + filename = params['filename'] >>>>> + os.system('rm -f %s.*' % filename) >>>> The extension can be different every time, so we have to check that. >>>> I'd >>>> prefer something like this: >>>> >>>> diff --git a/repos/domain/screenshot.py b/repos/domain/screenshot.py >>>> index 9986cab..c620085 100644 >>>> --- a/repos/domain/screenshot.py >>>> +++ b/repos/domain/screenshot.py >>>> @@ -39,8 +39,8 @@ def screenshot(params): >>>> st = conn.newStream(0) >>>> mime = dom.screenshot(st, params['screen'], 0) >>>> >>>> - ext = mimetypes.guess_extension(mime) or '.ppm' >>>> - filename = params['filename'] + ext >>>> + params['ext'] = mimetypes.guess_extension(mime) or '.ppm' >>> This modification on params couldn't be passed in >>> screenshot_clean() >>> The params to screenshot_clean() is the same as the >>> screenshot() which >>> is from testcase config file. >>> >>> >> Darn :( That's exactly why I wanted the parameter passing between tests >> :) What do you suggest? Should I save the extension into another file or >> do we have any other option? > The idea to share variable is reasonable, we can create a > shared_mod.py in > root of test-API, then import it in all of testcases, The first > testcase put the value in > this module for sharing with other modules. the connection object, > domain > network .etc could be shared in this way. > Except these fixed share object. we could define 3 or 5 customized > shared variable > for use. The contents of shared_mod.py should be like this: > > #shared_mod.py > con = None > domobj = None > netojb = None > stgobj = None > ... > defined_var1 = None > defined_var2 = None > defined_var3 = None > > Guannan Ren > I had an idea with expanding the parameters, tests could then share whatever they want, but this would break current tests when not handled correctly. I think your idea can be used now, just to fix these kind of things and we can treat the expansion into more sophisticated code as a major change and implement it after some release. Martin