├── ant
    ├── clean.xml
    ├── docs.xml
    ├── test.xml
    ├── prepare.xml
    ├── bootstrap.xml
    ├── package.xml
    └── compile.xml
├── ivy
    ├── ivy.xml
    └── ivysettings.xml
├── mkproject.sh
└── README.txt


/ant/clean.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
 2 | 
 3 |   <target name="clean" depends="init" description="erase built files and targets">
 4 |     <delete dir="${target.dir}" />
 5 |     <delete dir="${dist.dir}" />
 6 |     <!-- i dont think this is really a good idea: -->
 7 |     <!-- delete dir="${ivy.jar.dir}/cache/${ivy.organisation}" /-->
 8 |   </target>
 9 | 
10 |   <target name="clean-ivy" depends="prepare" description="erase ivy cache of downloaded packages">
11 |     <ivy:cleancache />
12 |   </target>
13 | 
14 |   <target name="clean-jni" depends="prepare" description="clean out any built jni targets" if="build.jni">
15 |     <ant dir="src/main/jni" target="clean" />
16 |   </target>
17 | 
18 |   <target name="distclean" depends="clean, clean-jni, clean-ivy" />
19 | 
20 | </project>
21 | 


--------------------------------------------------------------------------------
/ant/docs.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
 2 | 
 3 |   <target name="vscaladoc" depends="prepare" unless="skip.docs">
 4 |     <delete dir="${docs.target.dir}/scaladoc" />
 5 |     <mkdir dir="${docs.target.dir}/scaladoc" />
 6 |     <pathconvert property="doc.sources" pathsep=" ">
 7 |       <fileset dir="${source.dir}" includes="**/*.scala" />
 8 |     </pathconvert>
 9 |     <path id="docs.path">
10 |       <path refid="bootstrap.path" />
11 |       <pathelement location="${target.dir}/classes" />
12 |     </path>
13 |     <echo message="Building vscaladoc..." />
14 |     <java classname="org.scala_tools.vscaladoc.Main" fork="true" failonerror="true">
15 |       <classpath>
16 |         <path refid="bootstrap.path" />
17 |       </classpath>
18 |       <arg value="-classpath" />
19 |       <arg pathref="docs.path" />
20 |       <arg value="-d" />
21 |       <arg value="${docs.target.dir}/scaladoc" />
22 |       <arg value="-sourcepath" />
23 |       <arg value="${source.dir}/scala" />
24 |       <arg value="-windowtitle" />
25 |       <arg value="${ivy.module} ${ivy.revision}" />
26 |       <arg value="-doctitle" />
27 |       <arg value="${ivy.module} ${ivy.revision}" />
28 |       <arg value="-linksource" />
29 |       <arg line="${doc.sources}" />
30 |     </java>
31 |   </target>
32 | 
33 |   <target name="docs" depends="prepare,vscaladoc" unless="skip.docs"  description="build source documentation" />
34 | 
35 | </project>
36 | 


--------------------------------------------------------------------------------
/ivy/ivy.xml:
--------------------------------------------------------------------------------
 1 | <ivy-module version="1.0" xmlns:e="http://ant.apache.org/ivy/extra">
 2 |   <!-- CONFIG: net.lag.example is the example project we're going to setup" -->
 3 |   <!-- CONFIG: testclass is your test runner -->
 4 |   <!-- CONFIG: jarclassname is the name of your main class to run via java -jar -->
 5 |   <!-- CONFIG: thriftpackage is where generated thrift classes go. 
 6 |                Only matters if you're using thrift. -->
 7 |   <info organisation="com.example"
 8 |     module="echod"
 9 |     revision="1.0"
10 |     e:buildpackage="com.example.echod"
11 |     e:testclass="com.example.echod.TestRunner"
12 |     e:jarclassname="com.example.echod.Main"
13 |     e:thriftpackage="com.example.echod.gen"
14 |   />
15 | 
16 |   <configurations>
17 |     <conf name="bootstrap" visibility="private" description="load scala compiler and libraries" />
18 |     <conf name="default" description="normal build" />
19 |     <conf name="test" visibility="private" description="build and run tests" />
20 |   </configurations>
21 |   <dependencies>
22 |     <!-- want scala-compiler for running the console -->
23 |     <dependency org="org.scala-lang" name="scala-compiler" rev="2.7.3" />
24 |     <dependency org="org.scala-lang" name="scala-library" rev="2.7.3" />
25 |     <dependency org="org.scala-tools" name="vscaladoc" rev="1.1-md-3" conf="bootstrap->*" />
26 | 
27 |     <dependency org="commons-logging" name="commons-logging" rev="1.1" />
28 |     <dependency org="commons-lang" name="commons-lang" rev="2.2" />
29 |     <dependency org="org.scala-tools.testing" name="specs" rev="1.4.4" />
30 |     <dependency org="net.lag" name="configgy" rev="1.3" />
31 |     <dependency org="junit" name="junit" rev="4.4" /> <!--auto-->
32 |   </dependencies>
33 | </ivy-module>
34 | 


--------------------------------------------------------------------------------
/ant/test.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
 2 | 
 3 |   <target name="compile-tests" depends="prepare, compile" unless="skip.test" if="ivy.extra.testclass">
 4 |     <scalac srcdir="${test.source.dir}/scala" destdir="${target.dir}/test-classes" force="changed" deprecation="on">
 5 |       <classpath>
 6 |         <path refid="test.path" />
 7 |         <pathelement location="${target.dir}/classes" />
 8 |       </classpath>
 9 |       <include name="**/*.scala" />
10 |     </scalac>
11 |   </target>
12 | 
13 |   <macrodef name="run-test-class">
14 |     <attribute name="classname" />
15 |     <sequential>
16 |       <java classname="scala.tools.nsc.MainGenericRunner" fork="true" failonerror="true">
17 |         <classpath>
18 |           <path refid="test.path" />
19 |           <pathelement location="${target.dir}/classes" />
20 |           <pathelement location="${target.dir}/test-classes" />
21 |         </classpath>
22 |         <syspropertyset>
23 |           <propertyref builtin="all" />
24 |         </syspropertyset>
25 |         <jvmarg value="-Ddist.dir=${dist.dir}" />
26 |         <jvmarg value="-Djava.library.path=${dist.dir}:${dist.dir}/libs" />
27 |         <jvmarg value="-Xmx1200m" />
28 |         <arg value="@{classname}" />
29 |       </java>
30 |     </sequential>
31 |   </macrodef>
32 | 
33 |   <target name="run-unit-tests" unless="skip.test" if="ivy.extra.testclass">
34 |     <run-test-class classname="${ivy.extra.testclass}" />
35 |   </target>
36 | 
37 |   <target name="run-stress-tests" unless="skip.test" if="ivy.extra.stresstestclass">
38 |     <run-test-class classname="${ivy.extra.stresstestclass}" />
39 |   </target>
40 | 
41 |   <target name="unit" depends="compile-tests, run-unit-tests"
42 |     description="compile and run unit tests" />
43 | 
44 |   <target name="stress" depends="compile-tests, run-stress-tests"
45 |     description="compile and run stress tests" />
46 | 
47 |   <target name="test" depends="unit" />
48 | 
49 | </project>
50 | 


--------------------------------------------------------------------------------
/ivy/ivysettings.xml:
--------------------------------------------------------------------------------
 1 | <ivysettings>
 2 |   <settings defaultResolver="chain-repos" />
 3 |   <resolvers>
 4 |     <chain name="chain-repos" returnFirst="true">
 5 |       <filesystem name="local-third-party" transactional="false">
 6 |         <artifact pattern="${basedir}/third-party/java/[artifact]-[revision].[ext]" />
 7 |       </filesystem>
 8 |       <filesystem name="local" m2compatible="true" transactional="false" local="true" checkmodified="true">
 9 |         <artifact pattern="${basedir}/../repo/local/[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
10 |       </filesystem>
11 |       <filesystem name="local-libs" m2compatible="true" transactional="false" local="true" checkmodified="true">
12 |         <artifact pattern="${basedir}/libs/[artifact]-[revision].[ext]" />
13 |       </filesystem>
14 | 
15 |       <ibiblio name="scala-tools.org" m2compatible="true" root="http://scala-tools.org/repo-releases/" />
16 |       <ibiblio name="scala-tools.org-snapshots" m2compatible="true" root="http://scala-tools.org/repo-snapshots/" changingPattern=".*-SNAPSHOT" />
17 |       <!-- for smack, smackx -->
18 |       <ibiblio name="reucon" m2compatible="true" root="http://maven.reucon.com/public/" />
19 |       <!-- can't use poms because commons-io pom is corrupted -->
20 |       <ibiblio name="maven2" m2compatible="true" usepoms="false" />
21 |       <ibiblio name="lag.net" m2compatible="true" root="http://www.lag.net/repo/" />
22 |       <!-- for oauth -->
23 |       <ibiblio name="oauth.net" m2compatible="true" root="http://oauth.googlecode.com/svn/code/maven" />
24 |       <ibiblio name="powermock" m2compatible="true" root="http://powermock.googlecode.com/svn/repo/" />
25 |       <ibiblio name="jboss" m2compatible="true" root="http://repository.jboss.org/maven2/" />
26 |       <ibiblio name="mirrors.ibiblio.org" m2compatible="true" root="http://mirrors.ibiblio.org/pub/mirrors/maven2/" />
27 |       <ibiblio name="atlassian" m2compatible="true" root="https://m2proxy.atlassian.com/repository/public/" />
28 |     </chain>
29 |   </resolvers>
30 | 
31 |   <caches useOrigin="true" />
32 | </ivysettings>
33 | 


--------------------------------------------------------------------------------
/ant/prepare.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
 2 | 
 3 |   <!-- read the ivy files but don't resolve anything yet -->
 4 |   <target name="init" depends="install-ivy">
 5 |     <!-- override some ivy config. must happen before ivy:info even tho it's slightly recursive. -->
 6 |     <property name="ivy.distrib.dir" value="${dist.dir}" />
 7 |     <property name="ivy.deliver.ivy.pattern" value="${dist.dir}/[artifact]-[revision].[ext]" />
 8 | 
 9 |     <ivy:info file="${ivy.dep.file}" />
10 | 
11 |     <property name="jar.name" value="${ivy.module}-${ivy.revision}" />
12 |     <property name="dist.name" value="${ivy.module}-${ivy.revision}" />
13 |     <property name="dist.relative.dir" value="dist/${dist.name}" />
14 |     <property name="dist.dir" value="${basedir}/${dist.relative.dir}" />
15 |     <property name="docs.target.dir" value="${dist.dir}/docs" />
16 |   </target>
17 | 
18 |   <target name="resolve" depends="init">
19 |     <ivy:retrieve log="download-only" conf="bootstrap,default,test" pattern="${target.dir}/libs/[conf]/[artifact]-[type].[ext]" />
20 |     <ivy:cachepath pathid="bootstrap.path" conf="bootstrap" />
21 |     <ivy:cachepath pathid="deps.path" conf="default" />
22 |     <ivy:cachepath pathid="test.path" conf="test" />
23 |   </target>
24 | 
25 |   <target name="find-source">
26 |     <pathconvert property="build.java" setonempty="false">
27 |       <fileset dir="${source.dir}" includes="java/**/*.java" />
28 |     </pathconvert>
29 |     <pathconvert property="build.scala" setonempty="false">
30 |       <fileset dir="${source.dir}" includes="scala/**/*.scala" />
31 |     </pathconvert>
32 |     <pathconvert property="build.thrift" setonempty="false">
33 |       <fileset dir="${source.dir}" includes="thrift/**/*.thrift" />
34 |     </pathconvert>
35 |     <pathconvert property="build.jni" setonempty="false">
36 |       <fileset dir="${source.dir}" includes="jni/build.xml" />
37 |     </pathconvert>
38 |     <pathconvert property="copy.config" setonempty="false">
39 |       <fileset dir="${basedir}" includes="config/**" />
40 |     </pathconvert>
41 |   </target>
42 | 
43 |   <target name="prepare" depends="resolve, find-source" description="bootstrap ivy and scala, and download dependencies">
44 |     <taskdef resource="scala/tools/ant/antlib.xml" classpathref="bootstrap.path" />
45 |     <condition property="generate.scripts" value="true">
46 |       <available file="${basedir}/src/scripts" type="dir" />
47 |     </condition>
48 |     <mkdir dir="${target.dir}/classes" />
49 |     <mkdir dir="${target.dir}/test-classes" />
50 |     <mkdir dir="${dist.dir}" />
51 |   </target>
52 | 
53 | </project>
54 | 


--------------------------------------------------------------------------------
/ant/bootstrap.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
 2 | 
 3 |   <!-- defaults for all projects -->
 4 |   <property name="source.dir" value="${basedir}/src/main" />
 5 |   <property name="test.source.dir" value="${basedir}/src/test" />
 6 |   <property name="target.dir" value="${basedir}/target" />
 7 | 
 8 |   <property environment="env" />
 9 | 
10 |   <property name="ivy.install.version" value="2.1.0-rc1" />
11 |   <property name="ivy.jar.dir" value="${user.home}/.ivy2" />
12 |   <property name="ivy.jar.file" value="${ivy.jar.dir}/ivy-${ivy.install.version}.jar" />
13 |   <property name="jsch.install.version" value="0.1.29" />
14 |   <property name="jsch.jar.file" value="${ivy.jar.dir}/jsch-${jsch.install.version}.jar" />
15 | 
16 |   <!--
17 |     download ivy from the web site so that it can be used without being
18 |     installed. if the file has already been downloaded, we use a rename
19 |     trick to avoid hitting the website again. (that would be annoying
20 |     when building offline.)
21 |   -->
22 |   <target name="download-ivy" unless="skip.download">
23 |     <mkdir dir="${ivy.jar.dir}"/>
24 |     <condition property="ivy.url" value="file:${ivy.jar.file}">
25 |       <available file="${ivy.jar.file}" />
26 |     </condition>
27 |     <property name="ivy.url" value="http://repo1.maven.org/maven2/org/apache/ivy/ivy/${ivy.install.version}/ivy-${ivy.install.version}.jar" />
28 |     <get src="${ivy.url}" dest="${ivy.jar.file}.download" usetimestamp="true" />
29 |     <move file="${ivy.jar.file}.download" tofile="${ivy.jar.file}" />
30 | 
31 |     <condition property="jsch.url" value="file:${jsch.jar.file}">
32 |       <available file="${jsch.jar.file}" />
33 |     </condition>
34 |     <property name="jsch.url" value="http://repo1.maven.org/maven2/jsch/jsch/${jsch.install.version}/jsch-${jsch.install.version}.jar" />
35 |     <get src="${jsch.url}" dest="${jsch.jar.file}.download" usetimestamp="true" />
36 |     <move file="${jsch.jar.file}.download" tofile="${jsch.jar.file}" />
37 |   </target>
38 | 
39 |   <!-- import ivy's ant tasks -->
40 |   <target name="install-ivy" depends="download-ivy">
41 |     <path id="ivy.lib.path">
42 |       <fileset dir="${ivy.jar.dir}" includes="ivy-${ivy.install.version}.jar jsch-${jsch.install.version}.jar"/>
43 |     </path>
44 |     <taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path" />
45 |   </target>
46 | 
47 |   <!-- define filename-friendly names for the OS variants -->
48 |   <condition property="os.libsname" value="osx">
49 |     <os name="Mac OS X" />
50 |   </condition>
51 |   <condition property="os.jni.ext" value="jnilib">
52 |     <os name="Mac OS X" />
53 |   </condition>
54 |   <condition property="os.libsname" value="linux">
55 |     <os name="Linux" />
56 |   </condition>
57 |   <condition property="os.jni.ext" value="so">
58 |     <os name="Linux" />
59 |   </condition>
60 | 
61 |   <!-- where to look for the ivy config -->
62 |   <property name="ivy.dep.file" value="${basedir}/ivy/ivy.xml" />
63 |   <property name="ivy.settings.file" value="${basedir}/ivy/ivysettings.xml" />
64 | 
65 |   <import file="clean.xml" />
66 |   <import file="prepare.xml" />
67 |   <import file="compile.xml" />
68 |   <import file="test.xml" />
69 |   <import file="docs.xml" />
70 |   <import file="package.xml" />
71 | </project>
72 | 


--------------------------------------------------------------------------------
/mkproject.sh:
--------------------------------------------------------------------------------
 1 | 
 2 | inject_dep() {
 3 |   org=$1
 4 |   name=$2
 5 |   rev=$3
 6 | 
 7 |   cat ivy/ivy.xml | \
 8 |     awk "/  <\/dependencies>/ { print \"    <dependency org=\\\"${org}\\\" name=\\\"${name}\\\" rev=\\\"${rev}\\\" /> <!--auto-->\" } { print }" \
 9 |         > ivy/ivy2.xml && \
10 |     mv ivy/ivy2.xml ivy/ivy.xml
11 | }
12 | 
13 | reset_dep() {
14 |   cat ivy/ivy.xml | awk "!/<!--auto-->/ { print }" > ivy/ivy2.xml && mv ivy/ivy2.xml ivy/ivy.xml
15 | }
16 | 
17 | echo
18 | echo "Let's create a new scala project."
19 | read -p "  package root (like 'com.example'): " -e package_root
20 | read -p "  project name (like 'echod'): " -e project_name
21 | read -p "  description for humans: " -e description
22 | echo "  ----------"
23 | read -p "  using thrift? [n]: " -e use_thrift
24 | read -p "  using jmock? [n]: " -e use_jmock
25 | 
26 | test "x$package_root" = "x" && package_root="com.example"
27 | test "x$project_name" = "x" && project_name="echod"
28 | test "x$description" = "x" && description="sample project"
29 | test "x$use_thrift" = "x" && use_thrift="n"
30 | test "x$use_jmock" = "x" && use_jmock="n"
31 | package_path=$(echo ${package_root} | sed -e 's/\./\//g')
32 | 
33 | echo
34 | echo "Creating project ${package_root}.${project_name}"
35 | reset_dep
36 | 
37 | cat ivy/ivy.xml | \
38 |   sed -e "s/organisation=\".*\"/organisation=\"${package_root}\"/" \
39 |       -e "s/module=\".*\"/module=\"${project_name}\"/" \
40 |       -e "s/e:buildpackage=\".*\"/e:buildpackage=\"${package_root}.${project_name}\"/" \
41 |       -e "s/e:testclass=\".*\"/e:testclass=\"${package_root}.${project_name}.TestRunner\"/" \
42 |       -e "s/e:jarclassname=\".*\"/e:jarclassname=\"${package_root}.${project_name}.Main\"/" \
43 |       -e "s/e:thriftpackage=\".*\"/e:thriftpackage=\"${package_root}.${project_name}.gen\"/" \
44 |       > ivy/ivy2.xml && \
45 |   mv ivy/ivy2.xml ivy/ivy.xml
46 | 
47 | cat build.xml | \
48 |   sed -e "s/<project name=\".*\" default/<project name=\"${project_name}\" default/" \
49 |       -e "s/<description>.*<\/description>/<description>${description}<\/description>/" \
50 |       > build2.xml && \
51 |   mv build2.xml build.xml
52 | 
53 | mkdir -p src/main/scala/${package_path}/${project_name}
54 | mkdir -p src/test/scala/${package_path}/${project_name}
55 | test $use_thrift = "n" || {
56 |   mkdir -p src/test/thrift
57 |   inject_dep thrift libthrift 20080411p1
58 | }
59 | 
60 | # temporarily needed due to bug in specs:
61 | inject_dep junit junit 4.4
62 | 
63 | test $use_jmock = "n" || {
64 |   inject_dep org.jmock jmock 2.4.0
65 |   inject_dep org.hamcrest hamcrest-all 1.1
66 |   inject_dep cglib cglib 2.1_3
67 |   inject_dep asm asm 1.5.3
68 |   inject_dep objenesis objenesis 1.1
69 | }
70 | 
71 | cat >src/main/scala/${package_path}/${project_name}/Main.scala <<__EOF__
72 | package ${package_root}.${project_name}
73 | 
74 | object Main {
75 |   def main(args: Array[String]) {
76 |     println("Hello, world!")
77 |   }
78 | }
79 | __EOF__
80 | 
81 | cat >src/test/scala/${package_path}/${project_name}/TestRunner.scala <<__EOF__
82 | package ${package_root}.${project_name}
83 | 
84 | import org.specs.runner.SpecsFileRunner
85 | 
86 | object TestRunner extends SpecsFileRunner("src/test/scala/**/*.scala", ".*",
87 |   System.getProperty("system", ".*"), System.getProperty("example", ".*"))
88 | __EOF__
89 | 
90 | echo "Done."
91 | echo
92 | 
93 | # <!--dependency org="org.mockito" name="mockito-core" rev="1.7" conf="test->*"/-->
94 | 


--------------------------------------------------------------------------------
/README.txt:
--------------------------------------------------------------------------------
  1 | 
  2 | Folder layout:
  3 |   ant/  -- boilerplate ant files
  4 |   src/  -- source code
  5 |     main/
  6 |       scala/
  7 |       java/
  8 |       jni/
  9 |       thrift/
 10 |       resources/  -- files to copy into dist
 11 |     test/
 12 |       scala/
 13 |       resources/  -- files needed only for tests
 14 |     scripts/
 15 |   ivy/
 16 |     ivy.xml  -- package description
 17 |     ivysettings.xml  -- repositories
 18 |   config/  -- items to package in the distribution but not in jars
 19 | 
 20 | To configure, search through build.xml and ivy/ivy.xml for the 
 21 | string CONFIG and modify accordingly. The Ivy settings are also
 22 | documented below.
 23 | 
 24 | Created during the build:
 25 |   target/  -- compiled files
 26 |     classes/
 27 |     test-classes/
 28 |       resources/  -- copied from src/test/resources/
 29 |     gen-java/  -- generated from thrift
 30 |     scripts/
 31 |   dist/
 32 |     <package>-<version>/
 33 |       <package>-<version>.jar
 34 |       *.so  -- if jni stuff was compiled
 35 |       *.jnilib  -- if jni stuff was compiled
 36 |       libs/  -- dependent jars (and any extra)
 37 |       config/  -- copied over from config/
 38 |       resources/  -- from src/main/resources/
 39 | 
 40 | 
 41 | Primary targets
 42 | ---------------
 43 |   - clean
 44 |     - erase all generated/built files
 45 |   - distclean
 46 |     - clean *everything*
 47 |   - prepare
 48 |     - resolve dependencies and download them
 49 |   - compile
 50 |     - build any java/scala source
 51 |   - test
 52 |     - build and run test suite (requires e:testclass)
 53 |   - stress
 54 |     - (optional) run stress test suite (requires e:stresstestclass)
 55 |   - docs
 56 |     - generate documentation
 57 |   - package
 58 |     - copy all generated/built files into distribution folder
 59 |       (requires "local" repo)
 60 |   - push
 61 |     - copy all generated/built files into a final repository
 62 |       (requires "push" repo)
 63 | 
 64 | 
 65 | Properties that can change behavior
 66 | -----------------------------------
 67 | 
 68 | - skip.download
 69 |     if defined, don't download ivy; assume it's present
 70 | - skip.test
 71 |     if defined, don't run test suite
 72 | - skip.docs
 73 |     if defined, don't build docs
 74 | - libs.extra
 75 |     any extra files to copy into dist/<p>/libs/ during compile
 76 | - dist.extra
 77 |     any extra files to copy into dist/<p> during compile
 78 | - config.extra
 79 |     any extra files to copy into config/ during compile
 80 | - pack.deps
 81 |     if defined, pack dependent jars into the final dist jar, to remove dependencies
 82 | - thrift.bin
 83 |     location of the "thrift" executable
 84 | - push.build_name
 85 |     if defined, add the build name (and git revision) to jars when pushed to the repo
 86 | - dist.build_name
 87 |     if defined, add the git revision to the name of the final distribution zip file
 88 | - no.git
 89 |     if defined, don't try to fetch the current git head revision
 90 | 
 91 | 
 92 | Extra ivy thingies
 93 | ------------------
 94 | 
 95 | - e:buildpackage
 96 |     causes a build.properties file to be created in the named package
 97 |     (stores version #, etc -- used by RuntimeEnvironment in configgy)
 98 | - e:thriftpackage
 99 |     output package for generated thrift classes; causes thrift DDLs to be
100 |     compiled
101 | - e:testclass
102 |     class to execute for unit tests -- required, in order to run tests
103 | - e:stresstestclass
104 |     class to execute for stress tests (optional)
105 | - e:jarclassname
106 |     creates an executable jar with this as the main class name
107 | 
108 | 
109 | JNI
110 | ---
111 | 
112 | JNI will be built if there appears to be a `build.xml` file in src/main/jni/.
113 | That ant file should contain a "clean" target and a "compile" target.
114 | 
115 | Post-compile, the jni/ folder is expected to look like this:
116 |   src/
117 |     main/
118 |       jni/
119 |         build.xml  -- used to build the jni packages
120 |         <package>/
121 |           target/
122 |             *.so  -- copied into dist/<p>/
123 |             *.jnilib  -- copied into dist/<p>/
124 |             *.jar  -- copied into dist/<p>/
125 | 
126 | There may be as many <package> folders in jni/ as you desire.
127 | 
128 | 


--------------------------------------------------------------------------------
/ant/package.xml:
--------------------------------------------------------------------------------
  1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
  2 | 
  3 |   <!-- unzip all the dependent jars into target/ so that the final jar will depend on nothing. kinda evil. -->
  4 |   <target name="pack-deps" if="pack.deps">
  5 |     <pathconvert pathsep="," property="deps.path.list">
  6 |       <path refid="deps.path" />
  7 |       <map from="/" to="" />
  8 |     </pathconvert>
  9 |     <unzip dest="${target.dir}/classes">
 10 |       <fileset dir="/" includes="${deps.path.list}" />
 11 |     </unzip>
 12 |     <delete dir="${target.dir}/classes/META-INF" />
 13 |   </target>
 14 | 
 15 |   <target name="make-non-executable-jar" unless="ivy.extra.jarclassname" depends="pack-deps">
 16 |     <jar destfile="${dist.dir}/${jar.name}.jar">
 17 |       <fileset dir="${target.dir}/classes" />
 18 |     </jar>
 19 |   </target>
 20 | 
 21 |   <!-- generate a jar that contains all deps inside it, so it can be run with "java -jar" -->
 22 |   <target name="make-executable-jar" if="ivy.extra.jarclassname" depends="copy-extra,pack-deps">
 23 |     <pathconvert refid="deps.path" pathsep=" " property="deps.path.jar-format">
 24 |       <chainedmapper>
 25 |         <flattenmapper />
 26 |         <globmapper from="*" to="libs/*" />
 27 |       </chainedmapper>
 28 |     </pathconvert>
 29 |     <jar destfile="${dist.dir}/${jar.name}.jar">
 30 |       <fileset dir="${target.dir}/classes" />
 31 |       <manifest>
 32 |         <attribute name="Main-Class" value="${ivy.extra.jarclassname}" />
 33 |         <attribute name="Class-Path" value="${deps.path.jar-format}" />
 34 |       </manifest>
 35 |     </jar>
 36 |   </target>
 37 | 
 38 |   <target name="generate-scripts" depends="prepare" if="generate.scripts">
 39 |     <pathconvert refid="deps.path" property="classpath" />
 40 |     <pathconvert refid="test.path" property="test.classpath" />
 41 |     <pathconvert refid="deps.path" property="deps.path.dist-format">
 42 |       <chainedmapper>
 43 |         <flattenmapper />
 44 |         <globmapper from="*" to="$${DIST_HOME}/libs/*" />
 45 |       </chainedmapper>
 46 |     </pathconvert>
 47 | 
 48 |     <!-- delete dir="${basedir}/target/scripts" /-->
 49 |     <mkdir dir="${dist.dir}/scripts" />
 50 |     <copy todir="${dist.dir}/scripts" overwrite="true">
 51 |       <fileset dir="${basedir}/src/scripts" />
 52 |       <filterset>
 53 |         <filter token="CLASSPATH" value="${classpath}:${target.dir}/classes" />
 54 |         <filter token="TEST_CLASSPATH" value="${test.classpath}:${target.dir}/classes:${target.dir}/test-classes" />
 55 |         <filter token="DIST_CLASSPATH" value="${deps.path.dist-format}:$${DIST_HOME}/${jar.name}.jar" />
 56 |         <filter token="TARGET" value="${target.dir}" />
 57 |         <filter token="DIST_NAME" value="${dist.name}" />
 58 |       </filterset>
 59 |     </copy>
 60 |     <chmod dir="${dist.dir}/scripts" includes="*" perm="ugo+x" />
 61 |   </target>
 62 | 
 63 |   <target name="package" depends="test, make-non-executable-jar, make-executable-jar,
 64 |     generate-scripts, docs" description="build complete jar(s) and docs">
 65 |     <ivy:makepom ivyfile="${basedir}/ivy/ivy.xml" pomfile="${dist.dir}/${dist.name}.pom" />
 66 |     <ivy:deliver conf="*(public)" />
 67 |     <condition property="dist.zip.name"
 68 |                value="${dist.name}-${revision-short}.zip"
 69 |                else="${dist.name}.zip">
 70 |       <isset property="dist.build_name" />
 71 |     </condition>
 72 |     <zip destfile="${basedir}/dist/${dist.zip.name}"
 73 |          basedir="${basedir}/dist">
 74 |       <include name="${dist.name}/${jar.name}.jar" />
 75 |       <include name="${dist.name}/*.so" />
 76 |       <include name="${dist.name}/*.jnilib" />
 77 |       <include name="${dist.name}/libs/**" />
 78 |       <include name="${dist.name}/config/**" />
 79 |       <include name="${dist.name}/scripts/**" />
 80 |     </zip>
 81 |     <ivy:publish resolver="local" overwrite="true">
 82 |       <artifacts pattern="${dist.dir}/[artifact]-[revision].[ext]" />
 83 |     </ivy:publish>
 84 |   </target>
 85 | 
 86 |   <target name="jars" depends="package" />
 87 | 
 88 |   <target name="dist" depends="package" description="create a source distribution zipfile">
 89 |     <copy todir="${dist.dir}" failonerror="false">
 90 |       <fileset dir="${basedir}" includes="INSTALL* LICENSE* README* build.xml" />
 91 |     </copy>
 92 |     <copy todir="${dist.dir}/src">
 93 |       <fileset dir="src" />
 94 |     </copy>
 95 |     <copy todir="${dist.dir}/ivy">
 96 |       <fileset dir="ivy" />
 97 |     </copy>
 98 |     <copy todir="${dist.dir}/ant">
 99 |       <fileset dir="ant" />
100 |     </copy>
101 |     <zip destfile="${basedir}/dist/${ivy.module}-${ivy.revision}-src.zip"
102 |       basedir="${basedir}/dist"
103 |       includes="${ivy.module}-${ivy.revision}/**"
104 |       excludes="${ivy.module}-${ivy.revision}/libs/** ${ivy.module}-${ivy.revision}/*.jar" />
105 |   </target>
106 | 
107 |   <target name="push" depends="package" description="push built jar(s) to the repository">
108 |     <condition property="pubrevision"
109 |                value="${ivy.revision}-${build.timestamp.date}-${revision-short}"
110 |                else="${ivy.revision}">
111 |       <isset property="push.build_name" />
112 |     </condition>
113 |     <ivy:publish resolver="push" overwrite="true" pubrevision="${pubrevision}" update="true">
114 |       <artifacts pattern="${dist.dir}/[artifact]-${ivy.revision}.[ext]" />
115 |     </ivy:publish>
116 |   </target>
117 | </project>
118 | 


--------------------------------------------------------------------------------
/ant/compile.xml:
--------------------------------------------------------------------------------
  1 | <project xmlns:ivy="antlib:org.apache.ivy.ant">
  2 | 
  3 |   <property name="thrift.source.dir" value="${source.dir}/thrift" />
  4 |   <property name="thrift.target.dir" value="${target.dir}/gen-java" />
  5 | 
  6 | 
  7 |   <!-- generate thrift stubs if necessary -->
  8 | 
  9 |   <macrodef name="generate-thrift">
 10 |     <sequential>
 11 |       <pathconvert property="thrift.gen.path">
 12 |         <path location="${ivy.extra.thriftpackage}" />
 13 |         <unpackagemapper from="${basedir}/*" to="${thrift.target.dir}/*" />
 14 |       </pathconvert>
 15 |       <mkdir dir="${thrift.target.dir}" />
 16 |       <property name="thrift.bin" value="thrift" />
 17 |       <apply executable="${thrift.bin}" dest="${thrift.gen.path}" failonerror="true"
 18 |         skipemptyfilesets="true" verbose="true">
 19 |         <arg value="--gen" />
 20 |         <arg value="java" />
 21 |         <arg value="--gen" />
 22 |         <arg value="rb" />
 23 |         <arg value="-o" />
 24 |         <arg value="${target.dir}" />
 25 |         <arg value="" />
 26 |         <fileset dir="${thrift.source.dir}" includes="**/*.thrift" />
 27 |         <globmapper from="*.thrift" to="*.java" />
 28 |       </apply>
 29 |     </sequential>
 30 |   </macrodef>
 31 | 
 32 |   <macrodef name="compile-generated-thrift">
 33 |     <sequential>
 34 |       <javac srcdir="${thrift.target.dir}" destdir="${target.dir}/classes" deprecation="on">
 35 |         <classpath>
 36 |           <path refid="deps.path" />
 37 |         </classpath>
 38 |         <include name="**/*.java" />
 39 |       </javac>
 40 |     </sequential>
 41 |   </macrodef>
 42 | 
 43 |   <target name="compile-thrift" if="build.thrift">
 44 |     <generate-thrift />
 45 |     <compile-generated-thrift />
 46 |   </target>
 47 | 
 48 | 
 49 |   <!-- if there's any jni, compile it -->
 50 | 
 51 |   <target name="check-jni-source" if="build.jni">
 52 |     <!-- tricksy. remove any target files if any non-target files are newer. -->
 53 |     <dependset>
 54 |       <srcfileset dir="src/main/jni" excludes="**/target/*.${os.jni.ext} **/target/*.jar" />
 55 |       <targetfileset dir="src/main/jni" includes="**/target/*.${os.jni.ext} **/target/*.jar" />
 56 |     </dependset>
 57 |     <!-- and then only set build.jni.ok if those targets are "older" than build.xml (ie missing) -->
 58 |     <uptodate property="build.jni.ok" targetfile="src/main/jni/build.xml">
 59 |       <srcfiles dir="src/main/jni" includes="**/target/*.${os.jni.ext} **/target/*.jar" />
 60 |     </uptodate>
 61 |   </target>
 62 | 
 63 |   <target name="compile-jni" depends="check-jni-source" if="build.jni.ok">
 64 |     <ant dir="src/main/jni" target="compile" inheritAll="false" />
 65 |   </target>
 66 | 
 67 |   <target name="install-jni" depends="compile-jni" if="build.jni">
 68 |     <copy todir="${dist.dir}" flatten="true">
 69 |       <fileset dir="src/main/jni" includes="**/target/*.${os.jni.ext}" />
 70 |       <fileset dir="src/main/jni" includes="**/target/*.jar" />
 71 |     </copy>
 72 |   </target>
 73 | 
 74 |   <!-- compile old-skool java -->
 75 | 
 76 |   <target name="compile-java" if="build.java">
 77 |     <javac srcdir="${source.dir}/java" destdir="${target.dir}/classes" deprecation="on">
 78 |       <classpath>
 79 |         <path refid="deps.path" />
 80 |       </classpath>
 81 |       <include name="**/*.java" />
 82 |     </javac>
 83 |   </target>
 84 | 
 85 | 
 86 |   <!-- compile scala -->
 87 | 
 88 |   <target name="compile-scala" if="build.scala">
 89 |     <scalac srcdir="${source.dir}/scala" destdir="${target.dir}/classes" force="changed" deprecation="on">
 90 |       <classpath>
 91 |         <path refid="deps.path" />
 92 |       </classpath>
 93 |       <include name="**/*.scala" />
 94 |     </scalac>
 95 |   </target>
 96 | 
 97 | 
 98 |   <!-- create properties file with build info -->
 99 | 
100 |   <target name="find-git-revision" unless="no.git">
101 |     <!-- ask git for the current "head" commit-id, for memoizing inside the built jar -->
102 |     <exec outputproperty="revision" executable="git" failifexecutionfails="false">
103 |       <arg value="rev-parse" />
104 |       <arg value="HEAD" />
105 |     </exec>
106 |     <exec executable="git" failifexecutionfails="false">
107 |       <arg value="rev-parse" />
108 |       <arg value="HEAD" />
109 |       <redirector outputproperty="revision-short">
110 |         <outputfilterchain>
111 |           <tokenfilter>
112 |             <filetokenizer />
113 |             <replaceregex pattern="(.{8}).*" replace="\1"/>
114 |           </tokenfilter>
115 |         </outputfilterchain>
116 |       </redirector>
117 |     </exec>
118 |   </target>
119 | 
120 |   <target name="write-build-info" depends="init, find-git-revision" if="ivy.extra.buildpackage">
121 |     <tstamp>
122 |       <format property="build.timestamp.time" pattern="yyyyMMdd-HHmmss" />
123 |       <format property="build.timestamp.date" pattern="yyyyMMdd" />
124 |     </tstamp>
125 |     <pathconvert property="build.properties.path">
126 |       <path location="${ivy.extra.buildpackage}" />
127 |       <unpackagemapper from="${basedir}/*" to="${target.dir}/classes/*" />
128 |     </pathconvert>
129 |     <propertyfile file="${build.properties.path}/build.properties">
130 |       <entry key="name" value="${ivy.module}" />
131 |       <entry key="version" value="${ivy.revision}" />
132 |       <entry key="build_name" value="${build.timestamp.time}" />
133 |       <entry key="build_revision" value="${revision}" />
134 |     </propertyfile>
135 |   </target>
136 | 
137 | 
138 |   <!-- copy resources needed by tests and jar -->
139 | 
140 |   <target name="copy-resources">
141 |     <copy todir="${dist.dir}/libs" flatten="true">
142 |       <path refid="deps.path" />
143 |     </copy>
144 |     <copy todir="${target.dir}/test-classes/" failonerror="false">
145 |       <fileset dir="${test.source.dir}/resources" />
146 |     </copy>
147 |     <copy todir="${target.dir}/classes/" overwrite="true" failonerror="false">
148 |       <fileset dir="${source.dir}/resources" />
149 |     </copy>
150 |   </target>
151 | 
152 |   <target name="copy-config" if="copy.config">
153 |     <copy todir="${dist.dir}/config">
154 |       <fileset dir="${basedir}/config" />
155 |     </copy>
156 |   </target>
157 | 
158 |   <target name="copy-extra-config" if="config.extra">
159 |     <copy todir="${dist.dir}/config">
160 |       <fileset dir="${config.extra}" />
161 |     </copy>
162 |   </target>
163 | 
164 |   <target name="copy-extra-libs" if="libs.extra">
165 |     <copy todir="${dist.dir}/libs">
166 |       <path refid="libs.extra" />
167 |     </copy>
168 |   </target>
169 | 
170 |   <target name="copy-extra-dist" if="dist.extra">
171 |     <copy todir="${dist.dir}">
172 |       <path refid="dist.extra" />
173 |     </copy>
174 |   </target>
175 | 
176 |   <target name="copy-extra" depends="copy-resources, copy-config, copy-extra-config, copy-extra-libs, copy-extra-dist" />
177 | 
178 | 
179 |   <target name="compile" depends="prepare, find-source, compile-thrift, check-jni-source, compile-jni,
180 |     install-jni, compile-java, compile-scala, write-build-info, copy-extra"
181 |     description="compile java and scala code" />
182 | 
183 | </project>
184 | 


--------------------------------------------------------------------------------