https://github.com/jenkinsci/pyenv-pipeline-plugin

Execute commands in Python virtualenvs in Jenkins Pipeline DSL
https://github.com/jenkinsci/pyenv-pipeline-plugin

jenkins jenkins-pipeline jenkins-plugin jenkinsfile python virtualenv

Last synced: 11 days ago
JSON representation

Execute commands in Python virtualenvs in Jenkins Pipeline DSL

• Host: GitHub
• URL: https://github.com/jenkinsci/pyenv-pipeline-plugin
• Owner: jenkinsci
• License: mit
• Fork: true (cstarner/pyenv-pipeline)
• Created: 2017-09-21T19:49:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-24T21:54:00.000Z (almost 3 years ago)
• Last Synced: 2024-09-24T15:29:53.951Z (4 months ago)
• Topics: jenkins, jenkins-pipeline, jenkins-plugin, jenkinsfile, python, virtualenv
• Language: Java
• Homepage: https://plugins.jenkins.io/pyenv-pipeline/
• Size: 96.7 KB
• Stars: 33
• Watchers: 8
• Forks: 15
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pyenv Pipeline Plugin

A Jenkins plugin that provides a way to execute sh and 

bat Pipeline DSL commands within a specified Python

virtualenv.

## Overview

This plugin provides 1 new Pipeline DSL method:

* withPythonEnv: Specifies a Python virtualenv to execute

  any sh and bat DSL commands contained 

  within its block.

  

  withPythonEnv takes a single String argument, which

  specifies the Python executable to use for the virtualenv.

  pyenv-pipeline will use the executable to generate a corresponding

  virtualenv. At runtime, it will take a snapshot of environmental 

  variables with and without the virtualenv active. From this it generates

  a diff, and applies the environmental variable changes within the

  withPythonEnv block (reverting them after the block completes)

  

  The argument provided to withPythonEnv will first attempt

  to match it against the name of a ToolInstallation that

  is described by a ToolDescriptor with an ID that is contained

  within a pre-defined list of known Jenkins Python Tool plugin IDs. Currently,

  this plugin only looks to see if [ShiningPanda](https://github.com/jenkinsci/shiningpanda-plugin) is installed. If a 

  ToolInstallation is matched, the location of that tool is used

  as the Python executable to generate the virtualenv.

  

  If no ToolInstallation is matched, we attempt to treat the argument as 

  the location of an already existing virtualenv. A directory lookup is attempted with the

  string argument, and if the argument is determined to point to a virtualenv, we go

  ahead and use that. 

  

  * In order for this feature to work, the passed argument must end with the OS appropriate

  file separator.

  

  Lastly, the argument is treated as the literal location of the Python executable to be used. This can be used

  to specify a specific Python installation (if the location is known beforehand),

  or to fallback and use the systems default Python installation.

  

  * 
withPythonEnv('python') {

        // Uses the default system installation of Python

        // Equivalent to withPythonEnv('/usr/bin/python') 

        ...

    }

    

  * 
withPythonEnv('/usr/bin/python3.5') {

        // Uses the specific python3.5 executable located in /usr/bin

        ...

    }

  * 
withPythonEnv('CPython-2.7'){

        // Uses the ShiningPanda registered Python installation named 'CPython-2.7'

        ...

    }
  

    

  * 
withPythonEnv('/home/user/managed_virtualenv/'){

        // Uses the virtualenv that already exists at /home/user/managed_virtualenv/

        ...

    }


## Warnings:

  * Earlier version of this plugin relied on using pysh and

  pybat steps to execute code within withPythonEnv

  blocks. These steps are no longer necessary. To migrate, simply remove the py

  prefix from any such steps, and the command should work as intended. The steps are

  still included, and are copies of the sh and bat steps. Eventually,

  the steps will be removed altogether.

  * Multibranch pipeline builds will occasionally generate very long path names

  triggering pypa/virtualenv#596. In these instances, use of this plugin is not

  an option, at least at this time.