python_packaging/test/test_fr01.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019,2020, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 """Test gmxapi functionality described in roadmap.rst."""
  36
  37 import gmxapi as gmx
  38
  39
  40 def test_fr1():
  41     """FR1: Wrap importable Python code.
  42
  43     gmxapi compatible operations are implemented with simple machinery that allows
  44     compartmentalized progress on functionality to be highly decoupled from
  45     implementing user-facing tools. Tools are provided in `gmx.operation` and
  46     demonstrated by implementing `gmx.commandline_operation`.
  47     """
  48     # commandline_operation helper creates a set of operations
  49     # that includes the discovery and execution of the program
  50     # named in `executable`.
  51     operation = gmx.commandline_operation(executable='true')
  52     operation.run()
  53     assert operation.output.returncode.result() == 0
  54
  55     operation = gmx.commandline_operation(executable='false')
  56     operation.run()
  57     assert operation.output.returncode.result() == 1