Merge pull request #29 from vsoch/add/tests

first go at adding tests

Author: vsoch

.travis.yml

@@ -0,0 +1,21 @@
+language: python
+
+sudo: true
+
+os: linux
+
+python:
+    - "2.7"
+    - "3.5"
+
+matrix:
+  allow_failures:
+    - python: "2.6"
+    - python: "3.5"
+
+before_install:
+  - sudo chmod u+x .travis/*
+  - /bin/bash .travis/before_install
+
+script:
+  - /bin/bash .travis/script

.travis/before_install

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+sudo apt-get update && sudo apt-get install -y wget git build-essential squashfs-tools \
+                                                    libtool \
+                                                    autotools-dev \
+                                                    automake \
+                                                    autoconf \
+                                                    uuid-dev \
+                                                    libssl-dev
+
+
+sudo sed -i -e 's/^Defaults\tsecure_path.*$//' /etc/sudoers
+
+echo "PYTHON VERSION"
+which python
+
+python setup.py sdist && python setup.py install
+
+# Install Singularity (development)
+cd /tmp && git clone https://github.com/singularityware/singularity.git && cd singularity && ./autogen.sh && ./configure --prefix=/usr/local && make && sudo make install
+

.travis/script

@@ -0,0 +1,4 @@
+#!/bin/bash
+sudo apt-get install -y squashfs-tools
+python -m unittest discover -s $TRAVIS_BUILD_DIR/spython/tests/ -p '[t|T]est*.py'
+

CHANGELOG.md

@@ -17,6 +17,7 @@ The client here will eventually be released as "spython" (and eventually to
 singularity on pypi), and the versions here will coincide with these releases.
 
 ## [master](https://github.com/singularityhub/singularity-cli/tree/master)
+ - adding tests for client (0.0.30)
  - bug in Dockerfile fromHeader variable fix (0.0.29)
  - Dockerfile from "as level" removed (0.0.28)
  - fixed ENV parser to handle statements like A=B C=D

requirements.txt

@@ -0,0 +1 @@
+requests

spython/tests/__init__.py

@@ -0,0 +1,91 @@
+#!/usr/bin/python
+
+# Copyright (C) 2017-2018 Vanessa Sochat.
+# Copyright (C) 2018 The Board of Trustees of the Leland Stanford Junior
+# University.
+
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero 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 Affero General Public
+# License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from spython.utils import get_installdir
+from spython.logger import bot
+from spython.main import Client
+import unittest
+import tempfile
+import shutil
+import json
+import os
+
+
+print("########################################################### test_client")
+
+class TestClient(unittest.TestCase):
+
+    def setUp(self):
+        self.pwd = get_installdir()
+        self.cli = Client
+        self.tmpdir = tempfile.mkdtemp()
+
+    def tearDown(self):
+        shutil.rmtree(self.tmpdir)
+
+    def test_commands(self):
+
+        print('Testing client.build command')
+        container = "%s/container.img" %(self.tmpdir)
+
+        print("...Case 1: Build from docker uri")
+        created_container = self.cli.build('docker://ubuntu', 
+                                           image=container,
+                                           sudo=False)
+        self.assertEqual(created_container, container)
+        self.assertTrue(os.path.exists(created_container))
+        os.remove(container)
+
+        print("Testing client.pull command")
+        print("...Case 1: Testing naming pull by image name")
+        image = self.cli.pull("shub://vsoch/singularity-images", 
+                              pull_folder=self.tmpdir)
+        self.assertTrue(os.path.exists(image))
+        self.assertTrue('vsoch-singularity-images' in image)
+        print(image)
+
+        print('Testing client.run command')
+        result = self.cli.run(image)
+        print(result)
+        self.assertTrue('You say please, but all I see is pizza..' in result)
+        os.remove(image)
+
+        print("...Case 2: Testing docker pull")
+        container = self.cli.pull("docker://ubuntu:14.04",
+                                   pull_folder=self.tmpdir)
+        self.assertTrue("ubuntu:14.04" in container)
+
+        print(container)
+        self.assertTrue(os.path.exists(container))
+
+        print('Testing client.execute command')
+        result = self.cli.execute(container,'ls /')
+        print(result)
+        self.assertTrue('bin\nboot\ndev' in result)
+
+        print("Testing client.inspect command")
+        result = self.cli.inspect(container)
+        labels = json.loads(result)
+        self.assertTrue('data' in labels)     
+        os.remove(container)
+
+
+
+if __name__ == '__main__':
+    unittest.main()

spython/tests/test_client.py

@@ -0,0 +1,106 @@
+#!/usr/bin/python
+
+# Copyright (C) 2017-2018 Vanessa Sochat.
+# Copyright (C) 2018 The Board of Trustees of the Leland Stanford Junior
+# University.
+
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero 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 Affero General Public
+# License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from spython.utils import get_installdir
+import unittest
+import tempfile
+import shutil
+import json
+import os
+
+print("############################################################ test_utils")
+
+class TestUtils(unittest.TestCase):
+
+    def setUp(self):
+        self.pwd = get_installdir()
+        self.tmpdir = tempfile.mkdtemp()
+        
+    def tearDown(self):
+        shutil.rmtree(self.tmpdir)
+        
+
+    def test_write_read_files(self):
+        '''test_write_read_files will test the functions write_file and read_file
+        '''
+        print("Testing utils.write_file...")
+        from spython.utils import write_file
+        import json
+        tmpfile = tempfile.mkstemp()[1]
+        os.remove(tmpfile)
+        write_file(tmpfile,"hello!")
+        self.assertTrue(os.path.exists(tmpfile))        
+
+        print("Testing utils.read_file...")
+        from spython.utils import read_file
+        content = read_file(tmpfile)[0]
+        self.assertEqual("hello!",content)
+
+        from spython.utils import write_json
+        print("Testing utils.write_json...")
+        print("...Case 1: Providing bad json")
+        bad_json = {"Wakkawakkawakka'}":[{True},"2",3]}
+        tmpfile = tempfile.mkstemp()[1]
+        os.remove(tmpfile)        
+        with self.assertRaises(TypeError) as cm:
+            write_json(bad_json,tmpfile)
+
+        print("...Case 2: Providing good json")        
+        good_json = {"Wakkawakkawakka":[True,"2",3]}
+        tmpfile = tempfile.mkstemp()[1]
+        os.remove(tmpfile)
+        write_json(good_json,tmpfile)
+        with open(tmpfile,'r') as filey:
+            content = json.loads(filey.read())
+        self.assertTrue(isinstance(content,dict))
+        self.assertTrue("Wakkawakkawakka" in content)
+
+
+    def test_check_install(self):
+        '''check install is used to check if a particular software is installed.
+        If no command is provided, singularity is assumed to be the test case'''
+        print("Testing utils.check_install")
+        from spython.utils import check_install
+        is_installed = check_install()
+        self.assertTrue(is_installed)
+        is_not_installed = check_install('fakesoftwarename')
+        self.assertTrue(not is_not_installed)
+
+
+    def test_get_installdir(self):
+        '''get install directory should return the base of where singularity
+        is installed
+        '''
+        print("Testing utils.get_installdir")
+        from spython.utils import get_installdir
+        whereami = get_installdir()
+        print(whereami)
+        self.assertTrue('spython' in whereami)
+
+
+    def test_remove_uri(self):
+        print("Testing utils.remove_uri")
+        from spython.utils import remove_uri
+        self.assertEqual(remove_uri('docker://ubuntu'),'ubuntu')
+        self.assertEqual(remove_uri('shub://vanessa/singularity-images'),'vanessa/singularity-images')
+
+
+
+if __name__ == '__main__':
+    unittest.main()

spython/tests/test_utils.py

@@ -61,7 +61,7 @@ def check_install(software='singularity', quiet=True):
 def get_installdir():
     '''get_installdir returns the installation directory of the application
     '''
-    return os.path.abspath(os.path.dirname(__file__))
+    return os.path.abspath(os.path.join('..', os.path.dirname(__file__)))
 
 
 def stream_command(cmd, no_newline_regexp="Progess", sudo=False):

spython/utils/terminal.py

@@ -1,7 +1,7 @@
 
+# Copyright (C) 2017-2018 Vanessa Sochat.
 # Copyright (C) 2018 The Board of Trustees of the Leland Stanford Junior
 # University.
-# Copyright (C) 2017-2018 Vanessa Sochat.
 
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License as published by
@@ -18,7 +18,7 @@
 
 
 
-__version__ = "0.0.29"
+__version__ = "0.0.30"
 AUTHOR = 'Vanessa Sochat'
 AUTHOR_EMAIL = '[email protected]'
 NAME = 'spython'