NF: script to make local scripts from travis.yml

Author: matthew-brett

.travis.yml

@@ -22,10 +22,10 @@ env:
     - INSTALL_TYPE='system' VERSION=2.7 VENV=venv
 
 install:
-  - set -vx  # echo commands
   - source ./travis_tools.sh
   - get_python_environment $INSTALL_TYPE $VERSION $VENV
 
 script:
-  - echo $PWD
   - source test_tools.sh
+  - pip install nose
+  - nosetests test_travisparse.py

test_travisparse.py

@@ -0,0 +1,57 @@
+""" Nosetests for travis2bashes script
+"""
+
+from __future__ import absolute_import, print_function
+
+from travisparse import get_envs, TravisError
+from nose.tools import assert_equal, assert_true, assert_false, assert_raises
+
+
+def test_get_envs():
+    # Get fetch of environment from .travis.yml
+    assert_equal(get_envs({}), '')
+    assert_equal(get_envs(dict(install = ['something'])), '')
+    yaml = dict(env = {'global': ['LATEST_TAG=1'],
+                       'matrix': ['VERSION=2.7.8 NUMPY_VERSION=1.6.1',
+                                  'VERSION=3.3.5 NUMPY_VERSION=1.7.1',
+                                  'VERSION=3.4.1 NUMPY_VERSION=1.7.1']})
+    assert_equal(get_envs(yaml),
+"""LATEST_TAG=1
+VERSION=2.7.8 NUMPY_VERSION=1.6.1
+""")
+    yaml = dict(env = {'matrix': ['VERSION=2.7.8 NUMPY_VERSION=1.6.1',
+                                  'VERSION=3.3.5 NUMPY_VERSION=1.7.1',
+                                  'VERSION=3.4.1 NUMPY_VERSION=1.7.1']})
+    assert_equal(get_envs(yaml),
+"""VERSION=2.7.8 NUMPY_VERSION=1.6.1
+""")
+    yaml = dict(env = ['ISOLATED=true', 'ISOLATED=false'])
+    assert_equal(get_envs(yaml),
+"""ISOLATED=true
+""")
+    # excludes too complicated
+    yaml = dict(env = {'matrix':
+                       {'exclude':
+                        [{'gemfile': 'Gemfile', 'rvm': '2.0.0'}]}})
+    assert_raises(TravisError, get_envs, yaml)
+    # includes too complicated
+    yaml = dict(env = {'matrix':
+                       {'include':
+                        [{'gemfile': 'gemfiles/Gemfile.rails-3.2.x',
+                          'rvm': 'ruby-head',
+                          'env': 'ISOLATED=false'}]}})
+    assert_raises(TravisError, get_envs, yaml)
+    # global implies matrix
+    yaml = dict(env = {'global': ['LATEST_TAG=1']})
+    assert_raises(TravisError, get_envs, yaml)
+    # one line is OK too
+    yaml = dict(env = {'global': 'LATEST_TAG=1',
+                       'matrix': 'VERSION=3.3.1'})
+    assert_equal(get_envs(yaml),
+"""LATEST_TAG=1
+VERSION=3.3.1
+""")
+    yaml = dict(env = 'MY_VAR=1')
+    assert_equal(get_envs(yaml),
+"""MY_VAR=1
+""")

travis2bashes

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+""" Process .travis.yml and make bash fragments for testing
+
+Dump example vars, install, testing shell scripts to files for local testing
+"""
+from __future__ import print_function
+
+import os
+from os.path import join as pjoin
+import warnings
+
+import argparse # Python 2.6, really?
+
+# pip install pyyaml
+import yaml
+
+from travisparse import get_envs, TravisError, get_yaml_entry
+
+def main():
+    parser = argparse.ArgumentParser(
+        description='Extract bash fragments from .travis.yml file')
+    parser.add_argument('--out-dir', default='working',
+                        help = 'output directory for fragments')
+    parser.add_argument('--no-vars', action='store_true',
+                        help = 'do not write vars script file')
+    args = parser.parse_args()
+    out_dir = args.out_dir
+    with open('.travis.yml', 'rt') as fobj:
+        travis_dict = yaml.load(fobj)
+    try:
+        os.mkdir(out_dir)
+    except OSError:
+        pass
+    # vars
+    if not args.no_vars:
+        try:
+            var_str = get_envs(travis_dict)
+        except TravisError:
+            warnings.warn('Could not get travis vars from file')
+        else:
+            vars_fname = pjoin(out_dir, '_frag_travis_vars.sh')
+            with open(vars_fname, 'wt') as fobj:
+                fobj.write(var_str)
+            print("Written " + vars_fname)
+    # install
+    install = get_yaml_entry(travis_dict, 'install')
+    install_fname = pjoin(out_dir, '_frag_travis_install.sh')
+    with open(install_fname, 'wt') as fobj:
+        fobj.write('\n'.join(install) + '\n')
+    print('Written ' + install_fname)
+    # test
+    test = get_yaml_entry(travis_dict, 'script')
+    test_fname = pjoin(out_dir, '_frag_travis_test.sh')
+    with open(test_fname, 'wt') as fobj:
+        fobj.write('\n'.join(test) + '\n')
+    print('Written ' + test_fname)
+
+
+if __name__ == '__main__':
+    main()

travisparse.py

@@ -0,0 +1,71 @@
+""" Parse travis.yml file, partly
+"""
+import sys
+
+if sys.version_info[0] > 2:
+    basestring = str
+
+
+class TravisError(Exception):
+    pass
+
+
+def get_yaml_entry(yaml_dict, name):
+    """ Get entry `name` from dict `yaml_dict`
+
+    Parameters
+    ----------
+    yaml_dict : dict
+        dict or subdict from parsing .travis.yml file
+    name : str
+        key to analyze and return
+
+    Returns
+    -------
+    entry : None or list
+        If `name` not in `yaml_dict` return None.  If key value is a string
+        return a single entry list. Otherwise return the key value.
+    """
+    entry = yaml_dict.get(name)
+    if entry is None:
+        return None
+    if isinstance(entry, basestring):
+        return [entry]
+    return entry
+
+
+def get_envs(yaml_dict):
+    """ Get first env combination from travis yaml dict
+
+    Parameters
+    ----------
+    yaml_dict : dict
+        dict or subdict from parsing .travis.yml file
+
+    Returns
+    -------
+    bash_str : str
+        bash scripting lines as string
+    """
+    env = get_yaml_entry(yaml_dict, 'env')
+    if env is None:
+        return ''
+    # Bare string
+    if isinstance(env, basestring):
+        return env + '\n'
+    # Simple list defining matrix
+    if isinstance(env, (list, tuple)):
+        return env[0] + '\n'
+    # More complex dictey things
+    globals, matrix = [get_yaml_entry(env, name)
+                       for name in ('global', 'matrix')]
+    if hasattr(matrix, 'keys'):
+        raise TravisError('Oops, envs too complicated')
+    lines = []
+    if not globals is None:
+        if matrix is None:
+            raise TravisError('global section needs matrix section')
+        lines += globals
+    if not matrix is None:
+        lines.append(matrix[0])
+    return '\n'.join(lines) + '\n'