Merge into trunk : helpers_for_snapd_cli : Code : snappy-ecosystem-tests

Status:	Merged
Approved by:	Heber Parrucci on 2017-02-22
Approved revision:	37
Merged at revision:	23
Proposed branch:	lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli
Merge into:	lp:snappy-ecosystem-tests
Prerequisite:	lp:~canonical-platform-qa/snappy-ecosystem-tests/minor_tweaks
Diff against target:	359 lines (+314/-0) 6 files modified README.rst (+6/-0) requirements.txt (+2/-0) snappy_ecosystem_tests/helpers/snapd/snapd.py (+137/-0) snappy_ecosystem_tests/tests/test_snapd.py (+42/-0) snappy_ecosystem_tests/utils/ssh.py (+92/-0) snappy_ecosystem_tests/utils/user.py (+35/-0)
To merge this branch:	bzr merge lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Heber Parrucci (community)			Approve on 2017-02-22
Santiago Baldassin (community)			Approve on 2017-02-22
platform-qa-bot	continuous-integration		Approve on 2017-02-22
I Ahmad (community)		2017-02-06	Needs Fixing on 2017-02-07
Review via email: mp+316459@code.launchpad.net

Revision history for this message

I Ahmad (iahmad) wrote on 2017-02-07:

#

Please see my inline comments

review: Needs Fixing

Revision history for this message

I Ahmad (iahmad) on 2017-02-07:

#

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-07

8. By Omer Akram on 2017-02-07: merge with trunk
9. By Omer Akram on 2017-02-07: Assert when logged in

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-07:

#

Replied inline.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-07

10. By Omer Akram on 2017-02-07: fix login command

Revision history for this message

I Ahmad (iahmad) wrote on 2017-02-07:

#

Download full text (7.7 KiB)

I am fine as long as data is not parsed/filtered within helper method

On Tue, Feb 7, 2017 at 7:48 PM, Omer Akram <email address hidden> wrote:

> Replied inline.
>
> Diff comments:
>
> >
> > === modified file 'tests/utils/snapd.py'
> > --- tests/utils/snapd.py 2017-02-06 14:05:03 +0000
> > +++ tests/utils/snapd.py 2017-02-06 14:05:03 +0000
> > @@ -17,3 +17,138 @@
> > # You should have received a copy of the GNU General Public License
> > # along with this program. If not, see <http://www.gnu.org/licenses/>.
> > #
> > +
> > +import getpass
> > +import os
> > +import subprocess
> > +import sys
> > +import shlex
> > +import shutil
> > +import tempfile
> > +
> > +import pexpect
> > +import yaml
> > +
> > +PATH_SNAP = '/usr/bin/snap'
> > +COMMAND_DOWNLOAD = 'download {snap} --channel={channel}'
> > +COMMAND_FIND = 'find {search_term}'
> > +COMMAND_INFO = 'info {snap}'
> > +COMMAND_INSTALL = 'install {snap} --channel={channel}'
> > +COMMAND_LOGIN = 'login {email}'
> > +COMMAND_LOGOUT = 'logout'
> > +COMMAND_REFRESH = 'refresh {snap} --channel={channel}'
> > +CHANNEL_STABLE = 'stable'
> > +PASSWORD_ROOT = 'changed'
> > +
> > +
> > +def is_root_user():
> > + """Return bool representing if the current user is root."""
> > + return os.getuid() == 0
> > +
> > +
> > +def run_snapd_command(parameters, return_output=False, cwd=None):
> > + """ Run the request snapd cli command.
> > +
> > + :param parameters: the snapd sub-command and their parameters.
> > + example: install core --beta
> > + :param return_output: Whether to return the stdout of the command.
> > + :param cwd: The current working directory for the command, defaults
> to
> > + pwd.
> > + :return: Optionally return the stdout of the command, depending if
> > + the value of `return_output` was True.
> > + """
> > + command = '{} {}'.format(PATH_SNAP, parameters)
> > + if return_output:
> > + raw_output = subprocess.check_output(
> > + shlex.split(command), universal_newlines=True, cwd=cwd)
> > + return raw_output.strip().split('\n')
> > + subprocess.check_call(shlex.split(command), cwd=cwd)
> > +
> > +
> > +def login(email, password):
> > + """Login to snapd.
> > +
> > + :param email: Ubuntu SSO account email address.
> > + :param password: Ubuntu SSO account password.
> > + """
> > + command = '{} {}'.format(COMMAND_LOGIN, email)
> > + if is_root_user():
> > + p = pexpect.spawnu(command, logfile=sys.stdout)
> > + else:
> > + p = pexpect.spawnu('{} {}'.format('sudo', command),
> logfile=sys.stdout)
> > + p.expect_exact(
> > + '[sudo] password for {}: '.format(getpass.getuser()))
> > + p.sendline(PASSWORD_ROOT)
> > + p.expect_exact('Password of "{}": '.format(email))
> > + p.sendline(password)
> > + p.wait()
> > +
>
> I added an assert to ensure the login was successful.
>
> > +
> > +def logout():
> > + run_snapd_command(COMMAND_LOGOUT)
> > +
> > +
> > +def download(snap, channel=CHANNEL_STABLE, path=None):
> > + """Download the requested snap.
> > +
> > + :param snap: name of the snap to download.
> > + :param channel:...

I am fine as long as data is not parsed/filtered within helper method

On Tue, Feb 7, 2017 at 7:48 PM, Omer Akram <omer.akram@canonical.com> wrote:

> Replied inline.
>
> Diff comments:
>
> >
> > === modified file 'tests/utils/snapd.py'
> > --- tests/utils/snapd.py      2017-02-06 14:05:03 +0000
> > +++ tests/utils/snapd.py      2017-02-06 14:05:03 +0000
> > @@ -17,3 +17,138 @@
> >  # You should have received a copy of the GNU General Public License
> >  # along with this program.  If not, see <http://www.gnu.org/licenses/>.
> >  #
> > +
> > +import getpass
> > +import os
> > +import subprocess
> > +import sys
> > +import shlex
> > +import shutil
> > +import tempfile
> > +
> > +import pexpect
> > +import yaml
> > +
> > +PATH_SNAP = '/usr/bin/snap'
> > +COMMAND_DOWNLOAD = 'download {snap} --channel={channel}'
> > +COMMAND_FIND = 'find {search_term}'
> > +COMMAND_INFO = 'info {snap}'
> > +COMMAND_INSTALL = 'install {snap} --channel={channel}'
> > +COMMAND_LOGIN = 'login {email}'
> > +COMMAND_LOGOUT = 'logout'
> > +COMMAND_REFRESH = 'refresh {snap} --channel={channel}'
> > +CHANNEL_STABLE = 'stable'
> > +PASSWORD_ROOT = 'changed'
> > +
> > +
> > +def is_root_user():
> > +    """Return bool representing if the current user is root."""
> > +    return os.getuid() == 0
> > +
> > +
> > +def run_snapd_command(parameters, return_output=False, cwd=None):
> > +    """ Run the request snapd cli command.
> > +
> > +    :param parameters: the snapd sub-command and their parameters.
> > +        example: install core --beta
> > +    :param return_output: Whether to return the stdout of the command.
> > +    :param cwd: The current working directory for the command, defaults
> to
> > +        pwd.
> > +    :return: Optionally return the stdout of the command, depending if
> > +        the value of `return_output` was True.
> > +    """
> > +    command = '{} {}'.format(PATH_SNAP, parameters)
> > +    if return_output:
> > +        raw_output = subprocess.check_output(
> > +            shlex.split(command), universal_newlines=True, cwd=cwd)
> > +        return raw_output.strip().split('\n')
> > +    subprocess.check_call(shlex.split(command), cwd=cwd)
> > +
> > +
> > +def login(email, password):
> > +    """Login to snapd.
> > +
> > +    :param email: Ubuntu SSO account email address.
> > +    :param password: Ubuntu SSO account password.
> > +    """
> > +    command = '{} {}'.format(COMMAND_LOGIN, email)
> > +    if is_root_user():
> > +        p = pexpect.spawnu(command, logfile=sys.stdout)
> > +    else:
> > +        p = pexpect.spawnu('{} {}'.format('sudo', command),
> logfile=sys.stdout)
> > +        p.expect_exact(
> > +            '[sudo] password for {}: '.format(getpass.getuser()))
> > +        p.sendline(PASSWORD_ROOT)
> > +    p.expect_exact('Password of "{}": '.format(email))
> > +    p.sendline(password)
> > +    p.wait()
> > +
>
> I added an assert to ensure the login was successful.
>
> > +
> > +def logout():
> > +    run_snapd_command(COMMAND_LOGOUT)
> > +
> > +
> > +def download(snap, channel=CHANNEL_STABLE, path=None):
> > +    """Download the requested snap.
> > +
> > +    :param snap: name of the snap to download.
> > +    :param channel: name of the release channel to download from.
> > +    :param path: The path to which the downloaded snap be saved to,
> defaults
> > +        to pwd.
> > +    """
> > +    command = COMMAND_DOWNLOAD.format(snap=snap, channel=channel)
> > +    if path and os.path.isdir(path):
> > +        with tempfile.TemporaryDirectory() as tempdir:
> > +            run_snapd_command(command, cwd=tempdir)
> > +            for file in os.listdir(tempdir):
> > +                shutil.move(os.path.join(tempdir, file), path)
> > +    else:
> > +        run_snapd_command(command)
> > +
> > +
> > +def install(snap, channel=CHANNEL_STABLE):
> > +    """Install the requested snap."""
> > +    run_snapd_command(COMMAND_INSTALL.format(snap=snap,
> channel=channel))
> > +
> > +
> > +def info(snap, verbose=False):
> > +    """Query the Ubuntu store of the information about a snap.
> > +
> > +    :param snap: Name of the snap for which the info is required.
> > +    :param verbose: Whether to information should be detailed.
> > +    :return: Return a dictionary containing information about the snap.
> > +    """
> > +    command = COMMAND_INFO.format(snap=snap)
> > +    if verbose:
> > +        command = ' '.join([command, '--verbose'])
> > +    output = run_snapd_command(command, return_output=True)
> > +    return yaml.load("""{}""".format(output))
> > +
> > +
> > +def refresh(snap, channel=CHANNEL_STABLE):
> > +    """Refresh the requested snap."""
> > +    run_snapd_command(COMMAND_REFRESH.format(snap=snap,
> channel=channel))
> > +
> > +
> > +def find(keyword, **client_side_filters):
> > +    """Find snaps based on the provided filters
> > +
> > +    :param keyword: Keyword to use for the query.
> > +    :param client_side_filters: Whether to filter the results based on
> > +        additional constraints that are not supported by the server.
> > +    :return: Return a list of dictionaries containing information about
> > +        snaps matching the find criteria.
> > +    """
> > +    raw_output = run_snapd_command(
> > +        COMMAND_FIND.format(search_term=keyword), return_output=True)
> > +    headers = [header.lower() for header in raw_output.pop(0).split()]
> > +    organized_data = [dict(zip(headers, line.split())) for line in
> raw_output]
> > +    if len(client_side_filters) > 0:
> > +        filtered_result = organized_data.copy()
> > +        for item in organized_data:
> > +            for key, value in client_side_filters.items():
> > +                if item.get(key) != value:
> > +                    filtered_result.remove(item)
> > +                    continue
> > +        return filtered_result
> > +    return organized_data
>
> We might want to consider making an exception in this case, the raw data
> is returned in the form:
>
> Name                Version  Developer  Notes  Summary
> hello-world-om26er  0.2      om26er     -      A great snap
> crossbar-om26er     0.15.0   om26er     -      Crossbar.io - WAMP
> application router
> omegat-cat          4.1.0-1  jz         -      OmegaT, the free (GPL)
> translation memory tool
> oman                0.1      kalikiana  -      Read manpages from the web
> on your local machine
>
> This is find for human eyes but each test would have to loop through lines
> and get what its looking for, on the contrary what our method does is, it
> returns items in the form:
>
> [{'summary': 'A', 'name': 'hello-world-om26er', 'version': '0.2',
> 'developer': 'om26er', 'notes': '-'}, {'summary': 'Crossbar.io', 'name':
> 'crossbar-om26er', 'version': '0.15.0', 'developer': 'om26er', 'notes':
> '-'}, {'summary': 'OmegaT,', 'name': 'omegat-cat', 'version': '4.1.0-1',
> 'developer': 'jz', 'notes': '-'}, {'summary': 'Read', 'name': 'oman',
> 'version': '0.1', 'developer': 'kalikiana', 'notes': '-'}]
>
> Note: no data loss, rather the same data, but serialized. We can also call
> find('om26er', developer='om26er') and it will locally filter the results
> and look of the form:
>
> [{'summary': 'A', 'name': 'hello-world-om26er', 'version': '0.2',
> 'developer': 'om26er', 'notes': '-'}, {'summary': 'Crossbar.io', 'name':
> 'crossbar-om26er', 'version': '0.15.0', 'developer': 'om26er', 'notes':
> '-'}]
>
> Now if we really have a requirement to return raw data, we could probably
> add a raw=True default parameter to the method so that it returns raw text
> by default and optionally returns serialized data. (Or the other way
> around). Thoughts ?
>
>
>
> --
> https://code.launchpad.net/~canonical-platform-qa/snappy-
> ecosystem-tests/helpers_for_snapd_cli/+merge/316459
> You are reviewing the proposed merge of lp:~canonical-platform-qa/
> snappy-ecosystem-tests/helpers_for_snapd_cli into
> lp:snappy-ecosystem-tests.
>

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-08

11. By Omer Akram on 2017-02-08: Simplify .
./snapd.py
./snapcraft.py
./__pycache__
./__pycache__/snapd.cpython-35.pyc
./__init__.py method to remove client side filtering

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-08:

#

Ok, removed the filtering code now.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-08:

#

FAILED: Continuous integration, rev:11
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/7/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1564/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/7/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-12

12. By Omer Akram on 2017-02-12: Merge with trunk

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-12:

#

FAILED: Continuous integration, rev:12
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/24/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1596/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/24/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-14:

#

I have made the suggested changes.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-14

13. By Omer Akram on 2017-02-14: Fix pylint complaints

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-14:

#

PASSED: Continuous integration, rev:13
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/31/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1609/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/31/rebuild

review: Approve (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-14

14. By Omer Akram on 2017-02-14: add fixme comment

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-14:

#

PASSED: Continuous integration, rev:14
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/33/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1611/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/33/rebuild

review: Approve (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-14

15. By Omer Akram on 2017-02-14: more compact code. always return command output

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-14:

#

PASSED: Continuous integration, rev:15
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/34/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1612/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/34/rebuild

review: Approve (continuous-integration)

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-16:

#

Looks good in general. Couple of comments inline. Additionally:

* Merge from trunk
* Can you add a single test that checks if it is possible to login in snapd? in /tests folder
* Can you move snapd.py from utils to helpers?

review: Needs Fixing

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-17

16. By Omer Akram on 2017-02-17: revert
17. By Omer Akram on 2017-02-17: merge with trunk
18. By Omer Akram on 2017-02-17: bring back changes
19. By Omer Akram on 2017-02-17: read password from config, other changes
20. By Omer Akram on 2017-02-17: add simple test case for snapd

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-17:

#

Replied inline also added a few simple test cases.

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-20:

#

Looks good. One comment inline

review: Needs Fixing

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-20:

#

sure, let me fix that.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-20:

#

FAILED: Continuous integration, rev:20
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/60/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1647/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/60/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-20

21. By Omer Akram on 2017-02-20: Update snapd helpers to execute over ssh

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-20:

#

FAILED: Continuous integration, rev:21
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/67/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1654/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/67/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-20

22. By Omer Akram on 2017-02-20: Merge with trunk
23. By Omer Akram on 2017-02-20: pylint happy

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-20:

#

FAILED: Continuous integration, rev:23
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/69/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1656/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/69/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-20:

#

I updated this branch to execute all commands over ssh. With paramiko we automagically get a persistent ssh connection, so the performance should not be a problem. The remote machine should have `expect` installed. Both snapd and snapcraft commands should work just fine over ssh. For store api calls, we need a small wrapper that builds curl commands based on our requirements to be run over ssh.

with that we can have a single way to run tests on all targets (kvm, bare metal, all-snap(in future), lxd or a tablet.)

TODO: run_command_over_ssh need to be changed to actually utilize connection persistence advantages of paramiko, but I wanted to check how we all think about this direction.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

FAILED: Continuous integration, rev:23
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/73/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1660/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/73/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-21:

#

Looks good. Just minor comments

review: Needs Fixing

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

24. By Omer Akram on 2017-02-21: Maintain persistent ssh object, fix review comments
25. By Omer Akram on 2017-02-21: rename and move ssh runner function to ssh.py

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-21:

#

Replied inline.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

FAILED: Continuous integration, rev:25
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/76/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1663/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/76/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

26. By Omer Akram on 2017-02-21: More readable calls

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

FAILED: Continuous integration, rev:26
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/77/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1664/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/77/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

27. By Omer Akram on 2017-02-21: fix some words

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

FAILED: Continuous integration, rev:27
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/78/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1665/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/78/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

28. By Omer Akram on 2017-02-21: ignore chrome driver from requirements

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

PASSED: Continuous integration, rev:28
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/79/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1666/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/79/rebuild

review: Approve (continuous-integration)

Revision history for this message

Santiago Baldassin (sbaldassin) wrote on 2017-02-21:

#

Looks good but I think the ssh approach does not entirely solve the issue we discussed. See inline

review: Needs Fixing

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-21:

#

Added a comment.

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-21:

#

Adding slightly less relevant comment.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

29. By Omer Akram on 2017-02-21: Add protection against direct initialization of SSHClient

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

FAILED: Continuous integration, rev:29
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/83/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1670/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/83/rebuild

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-21

30. By Omer Akram on 2017-02-21: Merge with trunk

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-21:

#

PASSED: Continuous integration, rev:30
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/84/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1671/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/84/rebuild

review: Approve (continuous-integration)

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-21:

#

See comments inline.

review: Needs Fixing

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

31. By Omer Akram on 2017-02-22: Add optional overriding of hostname and username to run commands

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Replied inline, also extended run_command to optionally take hostname and username as suggested in your code.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:31
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/86/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1673/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/86/rebuild

review: Approve (continuous-integration)

Revision history for this message

Santiago Baldassin (sbaldassin) wrote on 2017-02-22:

#

Reply inline. Let's talk about this over the phone before we get into an endless discussion

review: Needs Fixing

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Replied and lets chat.

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-22:

#

Reply inline. Let's talk offline

Revision history for this message

Sergio Cazzolato (sergio-j-cazzolato) wrote on 2017-02-22:

#

Comment inline

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

32. By Omer Akram on 2017-02-22: Update to a SSHManager approach to keep a pool of active connections

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:32
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/87/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1675/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/87/rebuild

review: Approve (continuous-integration)

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Replied inline.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

33. By Omer Akram on 2017-02-22: Add doc-string

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Sergio, replied inline.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:33
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/88/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1676/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/88/rebuild

review: Approve (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

34. By Omer Akram on 2017-02-22: More simpler and compact approach

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:34
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/89/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1677/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/89/rebuild

review: Approve (continuous-integration)

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

35. By Omer Akram on 2017-02-22: reuse some code

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:35
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/90/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1678/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/90/rebuild

review: Approve (continuous-integration)

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-22:

#

Looks much better. Just a question inline.
Additionally, can you update README with remote host credentials info? you can reuse User Credentials section in that file if you wish.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

36. By Omer Akram on 2017-02-22: update README for ssh credentials

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Updated README, added inline comments.

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:36
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/91/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1680/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/91/rebuild

review: Approve (continuous-integration)

Revision history for this message

Santiago Baldassin (sbaldassin) wrote on 2017-02-22:

#

Looks good. Minor comments inline

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-22:

#

Reply to Santiago's suggestion

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

Replied.

Revision history for this message

Omer Akram (om26er) wrote on 2017-02-22:

#

re.

lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli updated on 2017-02-22

37. By Omer Akram on 2017-02-22: Changes

Revision history for this message

platform-qa-bot (platform-qa-bot) wrote on 2017-02-22:

#

PASSED: Continuous integration, rev:37
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/95/
Executed test runs:
None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1684/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/95/rebuild

review: Approve (continuous-integration)

Revision history for this message

Santiago Baldassin (sbaldassin) wrote on 2017-02-22:

#

Looks Good. Thanks

review: Approve

Revision history for this message

Heber Parrucci (heber013) wrote on 2017-02-22:

#

Code LGTM. Let's land it.

review: Approve

snappy-ecosystem-tests

Merge lp:~canonical-platform-qa/snappy-ecosystem-tests/helpers_for_snapd_cli into lp:snappy-ecosystem-tests

Commit message

Description of the change

Preview Diff

Subscribers

 === modified file 'README.rst'
 --- README.rst	2017-02-20 22:56:17 +0000
 +++ README.rst	2017-02-22 19:08:43 +0000
@@ -69,10 +69,16 @@
  [user]
  user_email=^USER_NAME^
  user_password=^USER_PASSWORD^
++hostname_remote=^SSH_HOSTNAME^
++username_remote=^SSH_USERNAME^
++port_remote=^SSH_PORT^
  option 2 - Set the following environment variables:
  user_email=^USER_NAME^
  user_password=^USER_PASSWORD^
++hostname_remote=^SSH_HOSTNAME^
++username_remote=^SSH_USERNAME^
++port_remote=^SSH_PORT^
  Changing store:
 === modified file 'requirements.txt'
 --- requirements.txt	2017-02-21 12:00:19 +0000
 +++ requirements.txt	2017-02-22 19:08:43 +0000
@@ -16,3 +16,5 @@
  requests-toolbelt==0.6.0
  #chromedriver_installer
  pylxd
++pyyaml
++paramiko
 === modified file 'snappy_ecosystem_tests/helpers/snapd/snapd.py'
 --- snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-02-09 20:09:40 +0000
 +++ snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-02-22 19:08:43 +0000
@@ -17,3 +17,140 @@
  # You should have received a copy of the GNU General Public License
  # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ #
++
++"""Helpers around snapd command-line interface."""
++
++import json
++import logging
++
++import yaml
++
++from snappy_ecosystem_tests.utils import ssh
++
++PATH_SNAP = '/usr/bin/snap'
++COMMAND_DOWNLOAD = 'download {snap} --channel={channel}'
++COMMAND_FIND = 'find {search_term}'
++COMMAND_INFO = 'info {snap}'
++COMMAND_INSTALL = 'install {snap} --channel={channel}'
++COMMAND_LIST = 'list'
++COMMAND_LOGIN = 'login {email}'
++COMMAND_LOGOUT = 'logout'
++COMMAND_REFRESH = 'refresh {snap} --channel={channel}'
++COMMAND_REMOVE = 'remove {snap}'
++CHANNEL_STABLE = 'stable'
++COMMANDS_LOGIN = """\
++/usr/bin/expect \
++-c 'spawn snap login {email}' \
++-c 'expect \"Password*\"' \
++-c 'send {password}\\r' \
++-c 'interact'\
++"""
++LOGGER = logging.getLogger(__name__)
++
++
++def run_snapd_command_ssh(parameters, cwd=''):
++    """Run snapd command over ssh.
++
++    :param parameters: a string containing parameters for the `snap` command.
++    :param cwd: the current working directory on the remote where the command
++        should run.
++    :returns: stdout of the command
++    """
++    if cwd:
++        return ssh.run_command(
++            'cd {}; {} {}'.format(cwd, PATH_SNAP, parameters))
++    return ssh.run_command('{} {}'.format(PATH_SNAP, parameters))
++
++
++def login(email, password):
++    """Login to snapd.
++
++    :param email: Ubuntu SSO account email address.
++    :param password: Ubuntu SSO account password.
++    """
++    ssh.run_command(COMMANDS_LOGIN.format(email=email, password=password))
++    return is_logged_in(email)
++
++
++def is_logged_in(email):
++    """Return bool representing if the user is logged into snapd."""
++    try:
++        return json.loads(ssh.run_command('cat ~/.snap/auth.json')).get(
++            'email') == email
++    except ValueError:
++        return False
++
++
++def logout(email):
++    """Logout snapd current user."""
++    if is_logged_in(email):
++        run_snapd_command_ssh(COMMAND_LOGOUT)
++
++
++def download(snap, channel=CHANNEL_STABLE):
++    """Download the requested snap.
++
++    :param snap: name of the snap to download.
++    :param channel: name of the release channel to download from.
++    """
++    command = COMMAND_DOWNLOAD.format(snap=snap, channel=channel)
++    run_snapd_command_ssh(command, cwd=ssh.run_command('mktemp -d'))
++
++
++def install(snap, channel=CHANNEL_STABLE):
++    """Install the requested snap."""
++    run_snapd_command_ssh(COMMAND_INSTALL.format(snap=snap, channel=channel))
++
++
++def _is_installed(snap):
++    """Return bool representing whether a snap is installed."""
++    for installed_snap in _parse_output(run_snapd_command_ssh(COMMAND_LIST)):
++        if installed_snap['name'] == snap:
++            return True
++    return False
++
++
++def remove(snap):
++    """Remove a snap, if its already installed."""
++    if _is_installed(snap):
++        run_snapd_command_ssh(COMMAND_REMOVE.format(snap=snap))
++
++
++def info(snap, verbose=False):
++    """Query the Ubuntu store of the information about a snap.
++
++    :param snap: Name of the snap for which the info is required.
++    :param verbose: Whether to information should be detailed.
++    :return: Return a dictionary containing information about the snap.
++    """
++    command = COMMAND_INFO.format(snap=snap)
++    if verbose:
++        command = ' '.join([command, '--verbose'])
++    return yaml.load("""{}""".format(run_snapd_command_ssh(command)))
++
++
++def refresh(snap, channel=CHANNEL_STABLE):
++    """Refresh the requested snap."""
++    run_snapd_command_ssh(COMMAND_REFRESH.format(snap=snap, channel=channel))
++
++
++def _parse_output(raw_output):
++    """Pretty parse the output from snapd commands like `find` and `list`.
++
++    :param raw_output: The raw output returned from the command
++    :return: A list of dictionaries containing sorted results from the output.
++    """
++    split_output = raw_output.split('\n')
++    headers = [header.lower() for header in split_output.pop(0).split()]
++    return [dict(zip(headers, line.split())) for line in split_output]
++
++
++def find(keyword):
++    """Find snaps based on the provided filters
++
++    :param keyword: Keyword to use for the query.
++    :return: Return a list of dictionaries containing information about
++        snaps matching the `keyword`.
++    """
++    return _parse_output(
++        run_snapd_command_ssh(COMMAND_FIND.format(search_term=keyword)))
 === added file 'snappy_ecosystem_tests/tests/test_snapd.py'
 --- snappy_ecosystem_tests/tests/test_snapd.py	1970-01-01 00:00:00 +0000
 +++ snappy_ecosystem_tests/tests/test_snapd.py	2017-02-22 19:08:43 +0000
@@ -0,0 +1,42 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++
++#
++# Snappy Ecosystem Tests
++# Copyright (C) 2017 Canonical
++#
++# This program is free software: you can redistribute it and/or modify
++# it under the terms of the GNU General Public License as published by
++# the Free Software Foundation, either version 3 of the License, or
++# (at your option) any later version.
++#
++# This program is distributed in the hope that it will be useful,
++# but WITHOUT ANY WARRANTY; without even the implied warranty of
++# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++# GNU General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++#
++
++"""Snapd testcases."""
++
++import testtools
++
++from snappy_ecosystem_tests.helpers.snapd import snapd
++from snappy_ecosystem_tests.utils.storeconfig import get_store_credentials
++
++
++class SnapdTestCase(testtools.TestCase):
++    """Tests for snapd."""
++    def setUp(self):
++        super().setUp()
++
++    def test_info(self):
++        """Ensure the publisher of core snap in canonical."""
++        self.assertTrue('canonical', snapd.info('core')['publisher'])
++
++    def test_login(self):
++        """Login the snapd user."""
++        email, password = get_store_credentials()
++        self.assertTrue(snapd.login(email, password))
++        self.addCleanup(snapd.logout, email)
 === added file 'snappy_ecosystem_tests/utils/ssh.py'
 --- snappy_ecosystem_tests/utils/ssh.py	1970-01-01 00:00:00 +0000
 +++ snappy_ecosystem_tests/utils/ssh.py	2017-02-22 19:08:43 +0000
@@ -0,0 +1,92 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++
++#
++# Snappy Ecosystem Tests
++# Copyright (C) 2017 Canonical
++#
++# This program is free software: you can redistribute it and/or modify
++# it under the terms of the GNU General Public License as published by
++# the Free Software Foundation, either version 3 of the License, or
++# (at your option) any later version.
++#
++# This program is distributed in the hope that it will be useful,
++# but WITHOUT ANY WARRANTY; without even the implied warranty of
++# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++# GNU General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++#
++
++"""Module to connect to ssh client for running tests."""
++
++import paramiko
++
++from snappy_ecosystem_tests.utils.user import get_remote_host_credentials
++
++
++class SSHManager:
++    """Manager class to keep a pool of ssh connections."""
++    # Mangle the pool so that it cannot be easily touched from outside.
++    __connection_pool = []
++
++    def __init__(self):
++        raise NotImplementedError(
++            'Class cannot be instantiated, use get_instance() to get a '
++            'SSHClient instance.')
++
++    @staticmethod
++    def get_instance(hostname, username, port=22, **kwargs):
++        """Return the instance of SSHClient from a pool of active connections,
++        otherwise create a new connection and return."""
++        port = int(port)
++        client = SSHManager.get_client(hostname, username, port)
++        if client:
++            if not client.get_transport().is_active():
++                client.connect(
++                    hostname, username=username, port=port, **kwargs)
++        else:
++            client = paramiko.SSHClient()
++            client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
++            client.connect(hostname, username=username, port=port, **kwargs)
++            SSHManager.__connection_pool.append(client)
++        return client
++
++    @staticmethod
++    def sync():
++        """Update the connection pool to only keep alive connections."""
++        pool_copy = SSHManager.__connection_pool.copy()
++        for client in SSHManager.__connection_pool:
++            if not client.get_transport().is_alive():
++                pool_copy.remove(client)
++        SSHManager.__connection_pool = pool_copy
++
++    @staticmethod
++    def get_client(hostname, username, port):
++        """Return the matching client from the pool based on provided
++        constraints."""
++        connections = [
++            client for client in SSHManager.__connection_pool if
++            client.get_transport().getpeername() == (hostname, port) and
++            username == client.get_transport().get_username()
++        ]
++        return connections[0] if connections else None
++
++
++def run_command(command, hostname=None, username=None, port=None):
++    """Run the given command on remote machine over ssh.
++
++    :param command: a string of the command to run.
++    :param hostname: The host to run command on.
++    :param username: Name of the user on the remote host to login to.
++    :param port: SSH port number.
++    :raises ValueError: if command exits with non-zero status.
++    :return: the stdout of the command.
++    """
++    _hostname, _username, _port = get_remote_host_credentials()
++    ssh = SSHManager.get_instance(
++        hostname or _hostname, username or _username, port or _port)
++    _, stdout, stderr = ssh.exec_command(command)
++    if stdout.channel.recv_exit_status() != 0:
++        raise ValueError(stderr.read().decode())
++    return stdout.read().decode()
 === added file 'snappy_ecosystem_tests/utils/user.py'
 --- snappy_ecosystem_tests/utils/user.py	1970-01-01 00:00:00 +0000
 +++ snappy_ecosystem_tests/utils/user.py	2017-02-22 19:08:43 +0000
@@ -0,0 +1,35 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++
++#
++# Snappy Ecosystem Tests
++# Copyright (C) 2017 Canonical
++#
++# This program is free software: you can redistribute it and/or modify
++# it under the terms of the GNU General Public License as published by
++# the Free Software Foundation, either version 3 of the License, or
++# (at your option) any later version.
++#
++# This program is distributed in the hope that it will be useful,
++# but WITHOUT ANY WARRANTY; without even the implied warranty of
++# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++# GNU General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++#
++
++"""Get host user data."""
++
++import os
++
++from snappy_ecosystem_tests.commons.config import USER_CONFIG_STACK
++
++
++def get_remote_host_credentials():
++    """Return credentials for remote machine, to run commands on."""
++    return (USER_CONFIG_STACK.get('user', 'hostname_remote',
++                                  default=os.environ.get('hostname_remote')),
++            USER_CONFIG_STACK.get('user', 'username_remote',
++                                  default=os.environ.get('username_remote')),
++            USER_CONFIG_STACK.get('user', 'port_remote',
++                                  default=os.environ.get('port_remote')))