test/Java/multi-step.py

   1 #!/usr/bin/env python
   2 #
   3 # MIT License
   4 #
   5 # Copyright The SCons Foundation
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining
   8 # a copy of this software and associated documentation files (the
   9 # "Software"), to deal in the Software without restriction, including
  10 # without limitation the rights to use, copy, modify, merge, publish,
  11 # distribute, sublicense, and/or sell copies of the Software, and to
  12 # permit persons to whom the Software is furnished to do so, subject to
  13 # the following conditions:
  14 #
  15 # The above copyright notice and this permission notice shall be included
  16 # in all copies or substantial portions of the Software.
  17 #
  18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  19 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  20 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26 """
  27 Real-world test (courtesy Leanid Nazdrynau) of the multi-step
  28 capabilities of the various Java Builders.
  29
  30 TODO: the whole Applet facility is deprecated, need a new test.
  31 """
  32
  33 import os
  34 import pathlib
  35
  36 import TestSCons
  37
  38 test = TestSCons.TestSCons()
  39
  40 where_javac, java_version = test.java_where_javac()
  41 where_javah = test.java_where_javah()
  42 where_java_include=test.java_where_includes()
  43
  44 swig = test.where_is('swig')
  45 if not swig:
  46     test.skip_test('Can not find installed "swig", skipping test.\n')
  47
  48 # Skip this test on AppVeyor
  49
  50 # Skip this test as SCons doesn't (currently) predict the generated
  51 # inner/anonymous class generated .class files generated by gcj
  52 # and so will always fail
  53 if test.javac_is_gcj:
  54     test.skip_test('Test not valid for gcj (gnu java); skipping test(s).\n')
  55
  56 # TODO rework for 'javac -h', for now skip
  57 # The logical test would be:  if java_version > 9:
  58 # but java_where_javah() roots around and will find from an older version
  59 if not test.Environment().WhereIs('javah'):
  60     test.skip_test("No Java javah for version > 9, skipping test.\n")
  61
  62 # On some systems, the alternatives system does not remove javah even if the
  63 # preferred Java doesn't have it, so try another check
  64 javacdir = pathlib.Path(where_javac).parent
  65 javahdir = pathlib.Path(where_javah).parent
  66 if javacdir != javahdir:
  67     test.skip_test("Cannot find Java javah matching javac, skipping test.\n")
  68
  69 test.subdir(
  70     ['src'],
  71     ['src', 'HelloApplet'],
  72     ['src', 'HelloApplet', 'com'],
  73     ['src', 'javah'],
  74     ['src', 'jni'],
  75     ['src', 'server'],
  76     ['src', 'server', 'JavaSource'],
  77     ['src', 'server', 'JavaSource', 'com'],
  78     ['src', 'server', 'JavaSource', 'com', 'gnu'],
  79     ['src', 'server', 'JavaSource', 'com', 'gnu', 'scons'],
  80     ['src', 'server', 'JavaSource', 'com', 'gnu', 'scons', 'web'],
  81     ['src', 'server', 'JavaSource', 'com', 'gnu', 'scons', 'web', 'tools'],
  82     ['src', 'server', 'WebContent'],
  83     ['src', 'server', 'WebContent', 'META-INF'],
  84     ['src', 'server', 'WebContent', 'WEB-INF'],
  85     ['src', 'server', 'WebContent', 'WEB-INF', 'conf'],
  86     ['src', 'server', 'WebContent', 'WEB-INF', 'lib'],
  87     ['src', 'server', 'WebContent', 'theme'],
  88 )
  89
  90 test.write(['SConstruct'], """\
  91 import os, sys
  92
  93 if sys.platform == 'win32':
  94     # Ensure tests don't pick up link from mingw or cygwin
  95     tools = ['msvc', 'mslink', 'jar', 'javac', 'javah', 'swig']
  96 else:
  97     tools = ['default', 'javac', 'javah', 'swig']
  98
  99 _ = DefaultEnvironment(tools=[])
 100 env = Environment(tools=tools, CPPPATH=["$JAVAINCLUDES"])
 101 Export('env')
 102 # env.PrependENVPath('PATH',os.environ.get('PATH',[]))
 103 env['INCPREFIX'] = '-I'
 104 env.Append(SWIGFLAGS=['-c++', '$_CPPINCFLAGS'])
 105
 106 # this is for JNI
 107 # env.Append(CCFLAGS=['/IN:/jdk/v1.3.1/include','/IN:/jdk/v1.3.1/include/win32'])
 108
 109 # this for windows only C++ build
 110 # env.Append(CXXFLAGS='-GX')
 111
 112 env.Append(CPPPATH='.')
 113
 114 env.VariantDir('buildout', 'src', duplicate=0)
 115
 116 if sys.platform[:6] == 'darwin':
 117     env.Append(CPPPATH=['/System/Library/Frameworks/JavaVM.framework/Headers'])
 118
 119 # If you do not have swig on your system please remove
 120 # 'buildout/jni/SConscript' line from next call
 121 env.SConscript(
 122     [
 123         'buildout/server/JavaSource/SConscript',
 124         'buildout/HelloApplet/SConscript',
 125         'buildout/jni/SConscript',
 126         'buildout/javah/SConscript',
 127     ]
 128 )
 129 """)
 130
 131 test.write(['src', 'HelloApplet', 'Hello.html'], """\
 132 <HTML>
 133 <HEAD>
 134 <TITLE> Applet Hello </TITLE>
 135 </HEAD>
 136 <BODY>
 137 <CENTER>
 138 <applet name="Hello" archive="HelloApplet.jar" code="com.Hello.Hello.class"
 139     width="800" height="286" MAYSCRIPT>
 140 </applet>
 141 </CENTER>
 142 </BODY>
 143 </HTML>
 144
 145 """)
 146
 147 test.write(['src', 'HelloApplet', 'SConscript'], """\
 148 import os
 149
 150 Import("env")
 151 denv = env.Clone()
 152 classes = denv.Java(target='classes', source=['com'])
 153 # set correct path for jar
 154 denv['JARCHDIR'] = os.path.join(denv.Dir('.').get_abspath(), 'classes')
 155 denv.Jar('HelloApplet', classes)
 156
 157 # To sign applet you have to create keystore before and made a calls like this
 158
 159 # keystore='/path/to/jarsignkey'
 160 # denv['JARSIGNFLAGS']='-keystore '+keystore+' -storepass pass -keypass passkey'
 161 # denv['JARSIGNALIAS']='ALIAS'
 162 # denv['JARCOM']=[denv['JARCOM'],'$JARSIGNCOM']
 163 """)
 164
 165 test.write(['src', 'HelloApplet', 'com', 'Hello.java'], """\
 166 package com.Hello;
 167 import java.awt.*;
 168 import java.applet.*;
 169
 170 public class Hello extends Applet {
 171     static final long serialVersionUID = 0;
 172     public void paint(Graphics g)
 173     {
 174         g.drawString("Hello from SCons signed applet",250,150);
 175     }
 176 }
 177 """)
 178
 179 test.write(['src', 'javah', 'MyID.cc'], """\
 180 #include "MyID.h"
 181 #ifdef _MSC_VER
 182 __declspec(dllexport)
 183 #endif
 184 int getMyID()
 185 {
 186    return 0;
 187 }
 188 """)
 189
 190 test.write(['src', 'javah', 'MyID.java'], """\
 191 public class MyID
 192 {
 193     static private long current = System.currentTimeMillis();
 194     static public String get()
 195     {
 196         current++;
 197         return new Long( current ).toString();
 198     }
 199 }
 200 """)
 201
 202 test.write(['src', 'javah', 'SConscript'], """\
 203 Import('env')
 204 denv = env.Clone()
 205 denv['JARCHDIR'] = denv.Dir('.').get_abspath()
 206 denv.Jar('myid', 'MyID.java')
 207 denv.JavaH(denv.Dir('.').get_abspath(), 'MyID.java')
 208 denv.SharedLibrary('myid', 'MyID.cc')
 209 """)
 210
 211 test.write(['src', 'jni', 'A.java'], """\
 212 package web.jni;
 213
 214 public class A
 215 {
 216 class C
 217 {
 218     void echo2( String text )
 219     {
 220         System.out.println( text+"aa" );
 221
 222     }
 223 }
 224 class B
 225 {
 226     void echo( String text )
 227     {
 228         System.out.println( text );
 229         C c = new C();
 230         c.echo2("from B callin C");
 231     }
 232 }
 233     public void main( String[] x)
 234     {
 235         B b = new B();
 236         b.echo("123");
 237         C c = new C();
 238         c.echo2("456");
 239     }
 240 }
 241 """)
 242
 243 test.write(['src', 'jni', 'JniWrapper.cc'], """\
 244 #include <vector>
 245 #include <iostream>
 246
 247 #include "JniWrapper.h"
 248
 249 JniWrapper::JniWrapper( JNIEnv *pEnv )
 250     : mpEnv( pEnv )
 251 {
 252 }
 253
 254 JniWrapper::JniWrapper( const JniWrapper& rJniWrapper )
 255     : mpEnv( rJniWrapper.mpEnv )
 256 {
 257 }
 258
 259 JniWrapper::~JniWrapper()
 260 {
 261 }
 262
 263 JniWrapper& JniWrapper::operator=( const JniWrapper& rJniWrapper )
 264 {
 265     if ( this != &rJniWrapper )
 266     {
 267         mpEnv = rJniWrapper.mpEnv;
 268     }
 269     return *this;
 270 }
 271
 272 std::string JniWrapper::unmarshalString( jstring value )
 273 {
 274     std::string result;
 275     if( value )
 276     {
 277         const char *pStr = mpEnv->GetStringUTFChars( value, 0 );
 278         result = pStr;
 279         mpEnv->ReleaseStringUTFChars( value, pStr );
 280     }
 281     return result;
 282 }
 283
 284 jobject JniWrapper::marshalDouble( double value )
 285 {
 286     jclass classObject = mpEnv->FindClass( "java/lang/Double" );
 287     jmethodID constructorId = mpEnv->GetMethodID( classObject, "<init>", "(D)V" );
 288     jobject result = mpEnv->NewObject( classObject, constructorId, value );
 289
 290     return result;
 291 }
 292
 293 jobject JniWrapper::getVectorElement( jobject values, int i )
 294 {
 295     jclass vectorClass = mpEnv->FindClass( "java/util/Vector" );
 296     jmethodID methodID = mpEnv->GetMethodID( vectorClass,
 297                                              "elementAt",
 298                                              "(I)Ljava/lang/Object;" );
 299     jobject result = mpEnv->CallObjectMethod( values, methodID, i );
 300
 301     return result;
 302 }
 303
 304 jobject JniWrapper::newVector()
 305 {
 306     jclass vectorClass = mpEnv->FindClass( "java/util/Vector" );
 307     jmethodID   constructorID = mpEnv->GetMethodID( vectorClass, "<init>", "()V" );
 308     jobject result = mpEnv->NewObject( vectorClass, constructorID );
 309
 310     return result;
 311 }
 312
 313 void JniWrapper::addElement( jobject vector, jobject element )
 314 {
 315     jclass vectorClass = mpEnv->FindClass( "java/util/Vector" );
 316     jmethodID addElementMethodID = mpEnv->GetMethodID( vectorClass,
 317                                                        "addElement",
 318                                                        "(Ljava/lang/Object;)V" );
 319
 320     mpEnv->CallVoidMethod( vector, addElementMethodID, element );
 321 }
 322
 323 jobject JniWrapper::marshalDoubleVector( const std::vector<double>& rVector )
 324 {
 325     jobject result = newVector();
 326
 327     for ( int i = 0; i < rVector.size(); i++ )
 328     {
 329           addElement( result, marshalDouble( rVector[i] ) );
 330     }
 331
 332     return result;
 333 }
 334
 335 std::pair<std::string, std::string> JniWrapper::unmarshalPairString( jobject vector )
 336 {
 337     std::pair<std::string, std::string> result;
 338     result.first  = unmarshalString( (jstring)getVectorElement( vector, 0 ) );
 339     result.second = unmarshalString( (jstring)getVectorElement( vector, 1 ) );
 340
 341     return result;
 342 }
 343 """)
 344
 345 test.write(['src', 'jni', 'JniWrapper.h'], """\
 346 #ifndef JniWrapper_h
 347 #define JniWrapper_h
 348
 349 #include <jni.h>
 350 /**
 351  * Provides routines for dealing with JNI translation etc.
 352  */
 353
 354 class JniWrapper
 355 {
 356 public:
 357     JniWrapper( JNIEnv *pEnv );
 358     JniWrapper( const JniWrapper& rJniWrapper );
 359     virtual ~JniWrapper();
 360     JniWrapper& operator=( const JniWrapper& rJniWrapper );
 361
 362
 363     std::string unmarshalString( jstring value );
 364
 365     jstring marshalString( const std::string& value );
 366
 367     jbyteArray marshalByteArray( const std::string& value );
 368
 369     double unmarshalDouble( jobject value );
 370
 371     jobject marshalDouble( double value );
 372     jobject marshallStringVector( const std::vector<std::string>& rMap );
 373
 374     jobject marshalDoubleVector( const std::vector<double>& rVector );
 375     std::pair<std::string, std::string> unmarshalPairString( jobject );
 376
 377 protected:
 378     JNIEnv *mpEnv;
 379
 380 private:
 381     JniWrapper();
 382     jobject newVector();
 383     void addElement( jobject vector, jobject element );
 384     jobject getVectorElement( jobject values, int i );
 385
 386 };
 387
 388 #endif // JniWrapper_h
 389
 390
 391 """)
 392
 393 test.write(['src', 'jni', 'SConscript'], """\
 394 Import("env")
 395 denv = env.Clone()
 396
 397 denv.Append(SWIGFLAGS=['-java'])
 398 denv.SharedLibrary('scons', ['JniWrapper.cc', 'Sample.i'])
 399 denv['JARCHDIR'] = denv.Dir('.').get_abspath()
 400 denv.Jar(['Sample.i', 'A.java'])
 401 """)
 402
 403 test.write(['src', 'jni', 'Sample.h'], """\
 404 #include <vector>
 405 #include <iostream>
 406
 407 class SampleTest
 408 {
 409 public:
 410     std::vector<double> test1( std::pair<std::string, std::string> param )
 411     {
 412         std::vector<double> result;
 413         result.push_back(10);
 414         return result;
 415     }
 416 };
 417
 418 """)
 419
 420 test.write(['src', 'jni', 'Sample.i'], """\
 421 %module Sample
 422
 423 %{
 424 #include "Sample.h"
 425 #include "JniWrapper.h"
 426 %}
 427
 428 %typemap(jni)    std::vector<double>, std::vector<double>& "jobject"
 429 %typemap(jtype)  std::vector<double>, std::vector<double>& "java.util.Vector"
 430 %typemap(jstype) std::vector<double>, std::vector<double>& "java.util.Vector"
 431
 432 // return a Vector of Doubles
 433 %typemap(javaout) std::vector<double> {
 434     return $jnicall;
 435 }
 436 %typemap(out) std::vector<double> {
 437     JniWrapper JniWrapper(jenv);
 438     $result = JniWrapper.marshalDoubleVector( $1 );
 439 }
 440
 441 /*********************************************************************
 442  *
 443  * Pairs of String (IN/OUT)
 444  *
 445  *********************************************************************/
 446 %typemap(jni)     std::pair<std::string, std::string>, const std::pair<std::string, std::string>& "jobject"
 447 %typemap(jtype)   std::pair<std::string, std::string>, const std::pair<std::string, std::string>&  "java.util.Vector"
 448 %typemap(jstype)  std::pair<std::string, std::string>, const std::pair<std::string, std::string>&  "java.util.Vector"
 449 %typemap(javain)  std::pair<std::string, std::string>, const std::pair<std::string, std::string>&  "$javainput"
 450
 451 // pass in by reference a Vector of std::string
 452 %typemap(in) const std::pair<std::string, std::string>&   {
 453     $1 = new std::pair<std::string, std::string>();
 454     JniWrapper JniWrapper(jenv);
 455     *($1) = JniWrapper.unmarshalPairString( $input );
 456 }
 457
 458 //cleanup
 459 %typemap(freearg) const std::pair<std::string, std::string>& {
 460     delete $1;
 461 }
 462
 463 %include "Sample.h"
 464
 465 // generate:Sample.java
 466 // generate:SampleJni.java
 467 // generate:SampleTest.java
 468 """)
 469
 470 test.write(['src', 'server', 'JavaSource', 'SConscript'], """\
 471 import os
 472 Import ("env")
 473 classes=env.Java(target='classes',source=['com'])
 474
 475 HelloApplet=os.path.join('#/buildout/HelloApplet/HelloApplet.jar')
 476 env['WARXFILES']=['SConscript','.cvsignore']
 477 env['WARXDIRS']=['CVS']
 478 #env.War('scons',[classes,Dir('../WebContent'),HelloApplet])
 479 """)
 480
 481 test.write(['src', 'server', 'JavaSource', 'com', 'gnu', 'scons', 'web', 'tools', 'Bool.java'], """\
 482 package com.gnu.scons.web.tools;
 483 public class Bool {
 484     boolean flag;
 485
 486     public Bool()
 487     {
 488         flag = false;
 489     }
 490
 491     public Bool( boolean aFlag )
 492     {
 493         flag = aFlag;
 494     }
 495
 496     public boolean booleanValue()
 497     {
 498         return flag;
 499     }
 500 }
 501 """)
 502
 503 test.write(['src', 'server', 'JavaSource', 'com', 'gnu', 'scons', 'web', 'tools', 'StringUtils.java'], """\
 504 package com.gnu.scons.web.tools;
 505
 506 public class StringUtils
 507 {
 508     public static String toPercent( String value )
 509     {
 510         if ( value.equals("") )
 511         {
 512             return "";
 513         }
 514         else
 515         {
 516             return value + "%";
 517         }
 518     }
 519
 520 }
 521 """)
 522
 523 test.write(['src', 'server', 'WebContent', 'index.html'], """\
 524 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 525 <HTML>
 526 <HEAD>
 527 <META http-equiv="refresh" content="0;URL=go?action=home">
 528 <TITLE>index.html</TITLE>
 529 </HEAD>
 530 <BODY>
 531 <P><a href="go?action=home">go?action=home</a></P>
 532 </BODY>
 533 </HTML>
 534 """)
 535
 536 test.write(['src', 'server', 'WebContent', 'META-INF', 'MANIFEST.MF'], """\
 537 Manifest-Version: 1.0
 538 Class-Path:
 539
 540 """)
 541
 542 test.write(['src', 'server', 'WebContent', 'WEB-INF', 'web.xml'], """\
 543 <?xml version="1.0" encoding="UTF-8"?>
 544 <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
 545 <web-app id="WebExample">
 546     <display-name>scons</display-name>
 547     <servlet>
 548         <servlet-name>WebExample</servlet-name>
 549         <display-name>WebExample</display-name>
 550         <servlet-class>com.gnu.scons.web.tool.WebExample</servlet-class>
 551     </servlet>
 552     <servlet-mapping>
 553         <servlet-name>WebExample</servlet-name>
 554         <url-pattern>/go</url-pattern>
 555     </servlet-mapping>
 556     <welcome-file-list>
 557         <welcome-file>index.html</welcome-file>
 558         <welcome-file>index.htm</welcome-file>
 559     </welcome-file-list>
 560 </web-app>
 561 """)
 562
 563 test.write(['src', 'server', 'WebContent', 'WEB-INF', 'conf', 'app.properties'], """\
 564 logging = webExample.Example
 565 """)
 566
 567 test.write(['src', 'server', 'WebContent', 'theme', 'Master.css'], """\
 568 body
 569 {
 570     font-family: Helvetica,Sans-Serif;
 571     font-size: 11pt;
 572 }
 573 """)
 574
 575 test.run(arguments = '.')
 576
 577 test.must_exist(['buildout', 'javah', 'myid.jar'])
 578 test.must_exist(['buildout', 'javah', 'MyID', 'MyID.class'])
 579
 580 test.must_exist(['buildout', 'jni', 'Sample.class'])
 581 test.must_exist(['buildout', 'jni', 'Sample.java'])
 582 test.must_exist(['buildout', 'jni', 'SampleJNI.class'])
 583 test.must_exist(['buildout', 'jni', 'SampleJNI.java'])
 584 test.must_exist(['buildout', 'jni', 'SampleTest.java'])
 585
 586 # Some combinations of Java + SWIG apparently don't actually generate
 587 # a SampleTest.class file, while others do.  Only issue a warning if
 588 # it doesn't exist.
 589 p = test.workpath('buildout', 'jni', 'SampleTest.class')
 590 if not os.path.exists(p):
 591     print('Warning:  %s does not exist' % p)
 592
 593 test.up_to_date(arguments = '.')
 594
 595 test.pass_test()
 596
 597 # Local Variables:
 598 # tab-width:4
 599 # indent-tabs-mode:nil
 600 # End:
 601 # vim: set expandtab tabstop=4 shiftwidth=4: