adding a test case for opengrok python scripts (#2498)

Author: tulinkry

opengrok-tools/pom.xml

@@ -40,7 +40,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
 
     <properties>
         <python.system.executable>python3</python.system.executable>
-        <python.executable>env/bin/python</python.executable>
+        <python.environment>${project.build.directory}/env/bin</python.environment>
     </properties>
 
     <profiles>
@@ -53,7 +53,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
             </activation>
             <properties>
                 <python.system.executable>python</python.system.executable>
-                <python.executable>env/Scripts/python</python.executable>
+                <python.environment>${project.build.directory}/env/Scripts</python.environment>
             </properties>
         </profile>
     </profiles>
@@ -183,7 +183,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                         <!-- needed for 'pip install pylint' to work -->
                         <id>Upgrade pip</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>-m</argument>
@@ -204,7 +204,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                             <goal>exec</goal>
                         </goals>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>setup.py</argument>
@@ -218,7 +218,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                     <execution>
                         <id>Install python package for tests/pylint</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>setup.py</argument>
@@ -233,7 +233,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                     <execution>
                         <id>Install python lint and flake8</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>-m</argument>
@@ -251,7 +251,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                     <execution>
                         <id>Python lint</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>-m</argument>
@@ -269,7 +269,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                     <execution>
                         <id>Python flake8</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
                             <arguments>
                                 <argument>-m</argument>
@@ -288,8 +288,11 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                     <execution>
                         <id>Test python package</id>
                         <configuration>
-                            <executable>${python.executable}</executable>
+                            <executable>${python.environment}/python</executable>
                             <workingDirectory>${project.build.directory}</workingDirectory>
+                            <environmentVariables>
+                                <PATH>${python.environment}:${env.PATH}</PATH>
+                            </environmentVariables>
                             <arguments>
                                 <argument>setup.py</argument>
                                 <argument>test</argument>

opengrok-tools/setup.py

@@ -59,6 +59,9 @@ def get_version(version):
         'resource',
         'filelock'
     ],
+    tests_require=[
+        'parameterized'
+    ],
     entry_points={
         'console_scripts': [
             'opengrok-config-merge=opengrok_tools.config_merge:main',

opengrok-tools/src/test/python/test_binaries.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# See LICENSE.txt included in this distribution for the specific
+# language governing permissions and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at LICENSE.txt.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+#
+
+import unittest
+
+from parameterized import parameterized
+
+from opengrok_tools.utils.command import Command
+
+
+class TestApp(unittest.TestCase):
+    @parameterized.expand((
+            ('opengrok'),
+            ('opengrok-indexer'),
+            ('opengrok-groups'),
+            ('opengrok-config-merge'),
+            ('opengrok-deploy'),
+            ('opengrok-java'),
+            ('opengrok-mirror'),
+            ('opengrok-projadm'),
+            ('opengrok-reindex-project'),
+            ('opengrok-sync'),
+    ))
+    def test_opengrok_binary(self, command):
+        """
+        Test that installed command is able to run
+        :param command: the command name
+        :return:
+        """
+        pass
+        cmd = Command([command, '--help'])
+        cmd.execute()
+        self.assertEqual(0, cmd.getretcode())
+        self.assertEqual(Command.FINISHED, cmd.getstate())
+        self.assertTrue(len(cmd.getoutputstr()) > 1)
+
+
+if __name__ == '__main__':
+    unittest.main()