如何将 Play 与自定义模块和持续集成结合使用

Question

如何在 CI 系统中设置 Play 应用程序和（自定义）Play 模块的构建，以便当模块的构建良好时，构建会将模块工件安装在本地存储库中和/或将它们部署到远程存储库，并且应用程序使用该存储库中的工件？

该解决方案也应该适合在本地工作的开发人员。

我正在使用詹金斯，无论我尝试以何种方式执行此操作，都会遇到麻烦。

在详细说明我遇到的所有问题之前，我会等待，因为这很费力，也许其他人可以提供他们是如何做到的。

Answer 1

我在詹金斯中有一个从开发到生产都运行良好的设置。

首先是自定义模块存储库的 dependency.yml 中的配置

repositories:
    - modules:
        type: chain
        using:
            - localModules:
                type: local
                descriptor: "${application.path}/../[module]/conf/dependencies.yml"
                artifact: "${application.path}/../[module]"
            - repoModules:
                type: http
                artifact: "http://mynexus/nexus/content/repositories/releases/com/myorg/[module]/[revision]/[module]-[revision].zip"
        contains:
            - com.myorg -> *

，开发人员和 jenkins 首先在同一个存储库中搜索以查看模块是否存在，如果不存在，则前往 Nexus 存储库下载工件。

为了在 jenkins 中构建我的模块，我使用像这样的自定义 sh 脚本

#!/bin/bash
APPLICATION="myModule"
PLAY_PATH="/usr/local/play"
set –xe

$PLAY_PATH/play deps --sync
$PLAY_PATH/play build-module --require 1.2.3
VERSION=`grep self conf/dependencies.yml | sed "s/.*$APPLICATION //"`
echo "Sending $APPLICATION-$VERSION.zip to nexus repository"
curl --request POST --user user:passwd http://mynexus/nexus/content/repositories/releases/com/myorg/$APPLICATION/$VERSION/$APPLICATION-$VERSION.zip -F "file=@dist/$APPLICATION-$VERSION.zip"  --verbose

使用此脚本，您可以将模块推送到每个 jenkins 构建上的 nexus。这并不是我真正做的事情。我仅在构建版本时才使用 jenkins 发布模块来推送它。对于某个版本，我有一个特殊的脚本，

#!/bin/bash
APPLICATION="myModule"
PLAY_PATH="/usr/local/play"
set –xe

if [ -z "$RELEASE_VERSION" ]
then
  echo "Parameter RELEASE_VERSION is mandatory"
  exit 1
fi
if [ -z "$DEVELOPMENT_VERSION" ]
then
  echo "Parameter DEVELOPMENT_VERSION is mandatory"
  exit 1
fi
echo "Release version : $RELEASE_VERSION"
echo "Development version : $DEVELOPMENT_VERSION"
VERSION=`grep self conf/dependencies.yml | sed "s/.*$APPLICATION //"`
if [ "$RELEASE_VERSION" != "$VERSION" ]
then
  echo "Release version $RELEASE_VERSION and play version $VERSION in dependencies.yml does not match : release failed"
  exit 1
fi
REVISION=`svnversion .`
echo "Tag svn repository in revision $REVISION with version $VERSION"
svn copy -m "Version $VERSION" -r $REVISION http://mysvn/myRepo/$APPLICATION/trunk/ http://mysvn/myRepo/$APPLICATION/tags/$VERSION
echo "svn tag applied"
echo "Sending $APPLICATION-$VERSION.zip to nexus repository"
curl --request POST --user user:passwd http://mynexus/nexus/content/repositories/releases/com/myorg/$APPLICATION/$VERSION/$APPLICATION-$VERSION.zip -F "file=@dist/$APPLICATION-$VERSION.zip"  --verbose
echo "$APPLICATION-$VERSION.zip sent to nexus repository"
echo "Update module to version $DEVELOPMENT_VERSION"
sed -i "s/self\(.*\)$VERSION/self\1$DEVELOPMENT_VERSION/g" conf/dependencies.yml
svn commit -m "Version $DEVELOPMENT_VERSION" conf/dependencies.yml
svn update
echo "Version $DEVELOPMENT_VERSION créée"

该脚本在我们的 svn 存储库中放置一个标签，将模块推送到 nexus 并更新 dependency.yml 文件。

有了这个，jenkins 可以构建一个依赖于模块未发布的本地版本的应用程序，之后可以通过从 Nexus 存储库下载模块 artifcat 来构建应用程序。对于开发者来说也是一样的

Answer 2

我写了这个小剧本！命令基本上它做同样的事情，但很好地集成到 Play!

http://www.playframework.org/community/snippets/25

from play.utils import *
from poster.encode import multipart_encode
from poster.streaminghttp import register_openers
import urllib
import urllib2
import yaml

COMMANDS = ['nexus-commit',]

HELP = {
    'nexus-commit': 'push built module to nexus'
}

def execute(**kargs):
    app = kargs.get("app")
    args = kargs.get("args")
    play_env = kargs.get("env")

    print '~ '
    print '~ Commiting to nexus server'
    print '~ '

    app.check()
    nexus = app.readConf('nexus.server.url')
    user = app.readConf('nexus.server.user')
    password = app.readConf('nexus.server.password')

    if nexus:
        print '~ Found nexus repository : %s' % nexus
    else:
        print '~ No nexus server configured'
        print '~ Set up the following on your application.conf:'
        print '~    nexus.server.url'
        print '~    nexus.server.user'
        print '~    nexus.server.password'
        sys.exit(0)

    #Getting module version from dependencies file
    deps_file = os.path.join(app.path, 'conf', 'dependencies.yml')
    if os.path.exists(deps_file):
        f = open(deps_file)
        deps = yaml.load(f.read())
        #Is this a Play~ module?
        if "self" in deps:
            d = deps["self"].split(" ")
            module_version = d.pop()
            app_name = d.pop()
        else:
            app_name = app.name()
            print '~ This is not a Play module'
            module_version = app.readConf('application.version')
            if not module_version:
                print '~ '
                print '~ No application.version found in application.conf file'
                print '~ '
                module_version = raw_input('~ Provide version number to be pushed to Nexus:')
        f.close

    if module_version:
        print '~ Module version : %s' % module_version
        print '~ '
    else:
        print '~ No module version configured.'
        print '~ Configure your dependencies file properly'
        sys.exit(0)

    dist_dir = os.path.join(app.path, 'dist')

    #Only interested on .zip files
    for root, dirs, files in os.walk(dist_dir):
        files = [ fi for fi in files if fi.endswith(".zip") ]

    #Loop over all found files
    if len(files) >0:
        for file in files:
            if "-a" in args:
                #We won't ask the user if he wants to commit
                resp = "Y"
            else:
                resp = raw_input('~ Do you want to post %s to nexus? (Y/N) ' % file)
            if resp == 'Y':
                url = '%s/%s/%s-SNAPSHOT/%s-%s-SNAPSHOT.zip' % (nexus, app_name, module_version, app_name, module_version)
                print '~ '
                print '~ Sending %s to %s' % (file, url)

                try:
                    data = open(os.path.join(dist_dir, file), 'rb')
                except:
                    print '~ Error: could not open file %s for reading' % file
                    continue 

                openers = register_openers()
                #post data to Nexus using configured credentials
                passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
                passman.add_password(None, url, user, password)
                authhandler = urllib2.HTTPBasicAuthHandler(passman)
                openers.add_handler(authhandler)
                openers.add_handler(urllib2.HTTPHandler(debuglevel=1))
                datagen, headers = multipart_encode({"file": data})
                request = urllib2.Request(url, datagen, headers)

                try:
                    print urllib2.urlopen(request).read()
                    print '~ File correctly sent'
                except urllib2.HTTPError, err:
                    print '~ Error: Nexus replied with -- %s' % err

            else:
                print '~ '
                print '~ Skiping %s' % file
    else:
        print '~ '
        print '~ No module build found.'
        print '~ Try "play build-module" command first'
        print '~ '