Fix functional tests

* The order of elements in list returned by listdir() can vary and may
  not be sorted. This caused assertEqual in "test_listdir" to fail.
* Also, some systems may have xattrs belonging to selinux. So, a
  listxattr can list them too.
* Allow hostname/ip and volume name to be configured easily by setting
  it in test.conf. This enables functional tests to use a non-local volume.
* Cleanup volume before and after running functional tests.
* Added MANIFEST.in and LICENSE file

Change-Id: Icfa6eb60e8d8e7ed4d6ab8190a2a2c80688999a3
Signed-off-by: Prashanth Pai <ppai@redhat.com>

12 files changed, 312 insertions, 43 deletions

diff --git a/.gitignore b/.gitignore
index b42811a..5aa73ab 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1,9 @@
 .tox
-gluster_swift.egg-info
+gfapi.egg-info
 test/unit/.coverage
 test/unit/nosetests.xml
 test/unit/coverage.xml
 test/unit/cover
+functional_tests
 build
 *.pyc
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..8b15060
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,8 @@
+include README.md LICENSE
+include functional_tests.sh unittests.sh
+include test-requirements.txt
+include tox.ini
+recursive-include glusterfs *.py
+recursive-include test *.py
+include test/test.conf
+graft doc
diff --git a/doc/markdown/dev_guide.md b/doc/markdown/dev_guide.md
index f568986..9d2588d 100644
--- a/doc/markdown/dev_guide.md
+++ b/doc/markdown/dev_guide.md
@@ -169,7 +169,7 @@ gluster volume start test
 ### Important Notes:
 
 #### Definining a hostname
-GlusterFS does not allow for specifiyng `localhost` as a valid hostname when creating a volume, so `gfshost` was used in the functional tests. If you use a different hostname when creating the gluster volume, be sure to update the functional tests.
+GlusterFS does not allow for specifiyng `localhost` as a valid hostname when creating a volume. Make sure to set host and volume information in test/test.conf file. The default host is 'gfshost' and default volume name is 'test'.
 
 #### Stopping services
 For the purpose of running this test, stop the `firewalld` service and disable `selinux`.
diff --git a/tools/functional_tests.sh b/functional_tests.sh
index a347e1e..32fcbe6 100755
--- a/tools/functional_tests.sh
+++ b/functional_tests.sh
@@ -18,48 +18,29 @@
 # This program expects to be run by tox in a virtual python environment
 # so that it does not pollute the host development system
 
-sudo_env()
-{
-    sudo bash -c "PATH=$PATH $*"
-}
-
 cleanup()
 {
+    if [ -d "/export/brick/b1/" ]; then
         sudo rm -rf /export/brick/b1/* > /dev/null 2>&1
+    fi
 }
 
-quit()
-{
-        echo "$1"
-        exit 1
-}
-
-
 fail()
 {
-        cleanup
-	quit "$1"
+    cleanup
+    echo "$1"
+    exit 1
 }
 
 ### MAIN ###
 
-
-# Check the directories exist
-DIRS="/export/brick/b1"
-for d in $DIRS ; do
-	if [ ! -x $d ] ; then
-		quit "$d must exist as GlusterFS volume"
-	fi
-done
-
-
 mkdir functional_tests > /dev/null 2>&1
 nosetests -v --exe \
-	--with-xunit \
-	--xunit-file functional_tests/libgfapi-python.xml \
-    --with-html-output \
-    --html-out-file functional_tests/libgfapi-python-result.html \
-    test/functional || fail "Functional tests failed"
+          --with-xunit \
+          --xunit-file functional_tests/libgfapi-python.xml \
+          --with-html-output \
+          --html-out-file functional_tests/libgfapi-python-result.html \
+          test/functional || fail "Functional tests failed"
 
 cleanup
 exit 0
diff --git a/glusterfs/gfapi.py b/glusterfs/gfapi.py
index 974aac5..9217f18 100755
--- a/glusterfs/gfapi.py
+++ b/glusterfs/gfapi.py
@@ -25,6 +25,9 @@ import errno
 # Looks like ctypes is having trouble with dependencies, so just force them to
 # load with RTLD_GLOBAL until I figure that out.
 api = ctypes.CDLL(find_library("gfapi"), ctypes.RTLD_GLOBAL, use_errno=True)
+# The above statement "may" fail with OSError on some systems if libgfapi.so
+# is located in /usr/local/lib/. This happens when glusterfs is installed from
+# source. Refer to: http://bugs.python.org/issue18502
 
 # Wow, the Linux kernel folks really play nasty games with this structure.  If
 # you look at the man page for stat(2) and then at this definition you'll note
diff --git a/setup.py b/setup.py
index a098896..080a7f4 100644
--- a/setup.py
+++ b/setup.py
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from setuptools import setup, find_packages
+from setuptools import setup
 
 from glusterfs import __canonical_version__ as version
 
@@ -30,7 +30,7 @@ setup(
     author='Red Hat, Inc.',
     author_email='gluster-users@gluster.org',
     url='http://www.gluster.org',
-    packages=find_packages(exclude=['test']),
+    packages=['glusterfs', ],
     test_suite='nose.collector',
     classifiers=[
         'Development Status :: 5 - Production/Stable'
diff --git a/tools/test-requires b/test-requirements.txt
index 7031033..7031033 100644
--- a/tools/test-requires
+++ b/test-requirements.txt
diff --git a/test/__init__.py b/test/__init__.py
index e69de29..821f5e3 100644
--- a/test/__init__.py
+++ b/test/__init__.py
@@ -0,0 +1,32 @@
+# Copyright (c) 2012-2014 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import ConfigParser
+
+
+def get_test_config():
+    """
+    Reads test.conf config file which contains configurable options
+    to run functional tests.
+
+    :returns: ConfigParser instance if test.conf found, None otherwise.
+    """
+    dirname = os.path.dirname(__file__)
+    conf_file = dirname + "/test.conf"
+    if os.path.exists(conf_file):
+        config = ConfigParser.ConfigParser()
+        config.read(conf_file)
+        return config
+    return None
diff --git a/test/functional/libgfapi-python-tests.py b/test/functional/libgfapi-python-tests.py
index 3ef2401..5af7d70 100644
--- a/test/functional/libgfapi-python-tests.py
+++ b/test/functional/libgfapi-python-tests.py
@@ -20,6 +20,22 @@ import loremipsum
 import errno
 
 from glusterfs import gfapi
+from test import get_test_config
+from ConfigParser import NoSectionError, NoOptionError
+
+config = get_test_config()
+if config:
+    try:
+        HOST = config.get('func_test', 'gfs_host')
+    except (NoSectionError, NoOptionError):
+        HOST = 'gfshost'
+    try:
+        VOLNAME = config.get('func_test', 'gfs_volname')
+    except (NoSectionError, NoOptionError):
+        VOLNAME = 'test'
+else:
+    HOST = 'gfshost'
+    VOLNAME = 'test'
 
 
 class BinFileOpsTest(unittest.TestCase):
@@ -30,12 +46,19 @@ class BinFileOpsTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.vol = gfapi.Volume("gfshost", "test")
+        cls.vol = gfapi.Volume(HOST, VOLNAME)
         cls.vol.set_logging("/dev/null", 7)
-        cls.vol.mount()
+        ret = cls.vol.mount()
+        if ret == 0:
+            # Cleanup volume
+            cls.vol.rmtree("/", ignore_errors=True)
+        else:
+            raise Exception("Initializing volume %s:%s failed." %
+                            (HOST, VOLNAME))
 
     @classmethod
     def tearDownClass(cls):
+        cls.vol.rmtree("/", ignore_errors=True)
         cls.vol = None
 
     def setUp(self):
@@ -61,12 +84,19 @@ class FileOpsTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.vol = gfapi.Volume("gfshost", "test")
+        cls.vol = gfapi.Volume(HOST, VOLNAME)
         cls.vol.set_logging("/dev/null", 7)
-        cls.vol.mount()
+        ret = cls.vol.mount()
+        if ret == 0:
+            # Cleanup volume
+            cls.vol.rmtree("/", ignore_errors=True)
+        else:
+            raise Exception("Initializing volume %s:%s failed." %
+                            (HOST, VOLNAME))
 
     @classmethod
     def tearDownClass(cls):
+        cls.vol.rmtree("/", ignore_errors=True)
         cls.vol = None
 
     def setUp(self):
@@ -195,7 +225,7 @@ class FileOpsTest(unittest.TestCase):
 
         xattrs = self.vol.listxattr(self.path)
         self.assertFalse(isinstance(xattrs, types.IntType))
-        self.assertEqual(xattrs, ["trusted.key1", "trusted.key2"])
+        self.assertTrue(set(["trusted.key1", "trusted.key2"]) <= set(xattrs))
 
         buf = self.vol.getxattr(self.path, "trusted.key1", 32)
         self.assertFalse(isinstance(buf, types.IntType))
@@ -206,7 +236,7 @@ class FileOpsTest(unittest.TestCase):
 
         xattrs = self.vol.listxattr(self.path)
         self.assertFalse(isinstance(xattrs, types.IntType))
-        self.assertEqual(xattrs, ["trusted.key2"])
+        self.assertTrue(["trusted.key1"] not in xattrs)
 
 
 class DirOpsTest(unittest.TestCase):
@@ -217,13 +247,21 @@ class DirOpsTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.vol = gfapi.Volume("gfshost", "test")
+        cls.vol = gfapi.Volume(HOST, VOLNAME)
         cls.vol.set_logging("/dev/null", 7)
         cls.vol.mount()
+        ret = cls.vol.mount()
+        if ret == 0:
+            # Cleanup volume
+            cls.vol.rmtree("/", ignore_errors=True)
+        else:
+            raise Exception("Initializing volume %s:%s failed." %
+                            (HOST, VOLNAME))
         cls.testfile = "testfile"
 
     @classmethod
     def tearDownClass(cls):
+        cls.vol.rmtree("/", ignore_errors=True)
         cls.vol = None
         cls.testfile = None
 
@@ -254,6 +292,7 @@ class DirOpsTest(unittest.TestCase):
 
     def test_listdir(self):
         dir_list = self.vol.listdir(self.dir_path)
+        dir_list.sort()
         self.assertEqual(dir_list, ["testfile0", "testfile1", "testfile2"])
 
     def test_makedirs(self):
diff --git a/test/test.conf b/test/test.conf
new file mode 100644
index 0000000..4bf4dff
--- /dev/null
+++ b/test/test.conf
@@ -0,0 +1,3 @@
+[func_test]
+gfs_host = gfshost
+gfs_volname = test
diff --git a/tox.ini b/tox.ini
index 5a97c9b..78e2818 100644
--- a/tox.ini
+++ b/tox.ini
@@ -12,7 +12,7 @@ setenv = VIRTUAL_ENV={envdir}
          NOSE_OPENSTACK_STDOUT=1
 deps =
   --download-cache={homedir}/.pipcache
-  -r{toxinidir}/tools/test-requires
+  -r{toxinidir}/test-requirements.txt
 changedir = {toxinidir}/test/unit
 commands = nosetests -v --exe --with-xunit --with-coverage --cover-package glusterfs --cover-erase --cover-xml --cover-html --cover-branches --with-html-output {posargs}
 
@@ -21,12 +21,12 @@ downloadcache = ~/cache/pip
 
 [testenv:functest]
 changedir = {toxinidir}
-commands = bash tools/functional_tests.sh
+commands = bash functional_tests.sh
 
 [testenv:pep8]
 deps =
   --download-cache={homedir}/.pipcache
-  -r{toxinidir}/tools/test-requires
+  -r{toxinidir}/test-requirements.txt
 changedir = {toxinidir}
 commands =
   flake8