test/TestCommon.gmk
changeset 42424 2ac2a6ef14a6
child 46192 14c55d15c9d7
child 43780 314e36e4c783
equal deleted inserted replaced
42423:bc717b8b1123 42424:2ac2a6ef14a6
       
     1 #
       
     2 # Copyright (c) 1995, 2016, Oracle and/or its affiliates. All rights reserved.
       
     3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4 #
       
     5 # This code is free software; you can redistribute it and/or modify it
       
     6 # under the terms of the GNU General Public License version 2 only, as
       
     7 # published by the Free Software Foundation.  Oracle designates this
       
     8 # particular file as subject to the "Classpath" exception as provided
       
     9 # by Oracle in the LICENSE file that accompanied this code.
       
    10 #
       
    11 # This code is distributed in the hope that it will be useful, but WITHOUT
       
    12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14 # version 2 for more details (a copy is included in the LICENSE file that
       
    15 # accompanied this code).
       
    16 #
       
    17 # You should have received a copy of the GNU General Public License version
       
    18 # 2 along with this work; if not, write to the Free Software Foundation,
       
    19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20 #
       
    21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22 # or visit www.oracle.com if you need additional information or have any
       
    23 # questions.
       
    24 #
       
    25 
       
    26 #
       
    27 # Common logic to run various tests for a component, to be included by the
       
    28 # component specific test makefiles.
       
    29 #
       
    30 
       
    31 # Default values for some properties that can be overridden by components.
       
    32 USE_JTREG_VERSION ?= 4.2
       
    33 JTREG_VM_TYPE ?= -agentvm
       
    34 USE_JTREG_ASSERT ?= true
       
    35 LIMIT_JTREG_VM_MEMORY ?= true
       
    36 
       
    37 .DEFAULT : all
       
    38 
       
    39 # Empty these to get rid of some default rules
       
    40 .SUFFIXES:
       
    41 .SUFFIXES: .java
       
    42 CO=
       
    43 GET=
       
    44 
       
    45 # Utilities used
       
    46 AWK       = awk
       
    47 CAT       = cat
       
    48 CD        = cd
       
    49 CHMOD     = chmod
       
    50 CP        = cp
       
    51 CUT       = cut
       
    52 DIRNAME   = dirname
       
    53 ECHO      = echo
       
    54 EGREP     = egrep
       
    55 EXPAND    = expand
       
    56 FIND      = find
       
    57 MKDIR     = mkdir
       
    58 PWD       = pwd
       
    59 RM        = rm -f
       
    60 SED       = sed
       
    61 SORT      = sort
       
    62 TEE       = tee
       
    63 UNAME     = uname
       
    64 UNIQ      = uniq
       
    65 WC        = wc
       
    66 ZIPEXE    = zip
       
    67 
       
    68 # Get OS name from uname (Cygwin inexplicably adds _NT-5.1)
       
    69 UNAME_S := $(shell $(UNAME) -s | $(CUT) -f1 -d_)
       
    70 
       
    71 # Commands to run on paths to make mixed paths for java on windows
       
    72 ifeq ($(findstring CYGWIN,$(UNAME_S)), CYGWIN)
       
    73   # Location of developer shared files
       
    74   SLASH_JAVA = J:
       
    75   GETMIXEDPATH = cygpath -m
       
    76   PLATFORM = windows
       
    77 else
       
    78   # Location of developer shared files
       
    79   SLASH_JAVA = /java
       
    80   GETMIXEDPATH = $(ECHO)
       
    81   PLATFORM = unix # we only care about windows or bsd.
       
    82   ifeq ($(UNAME_S), Darwin)
       
    83     PLATFORM = bsd
       
    84   endif
       
    85   ifeq ($(findstring BSD,$(UNAME_S)), BSD)
       
    86     PLATFORM = bsd
       
    87   endif
       
    88 endif
       
    89 
       
    90 ifdef ALT_SLASH_JAVA
       
    91   SLASH_JAVA = $(ALT_SLASH_JAVA)
       
    92 endif
       
    93 
       
    94 # Root of this test area (important to use full paths in some places)
       
    95 TEST_ROOT := $(shell $(PWD))
       
    96 
       
    97 # Root of all test results
       
    98 ifdef TEST_OUTPUT_DIR
       
    99   $(shell $(MKDIR) -p $(TEST_OUTPUT_DIR)/jtreg)
       
   100   ABS_TEST_OUTPUT_DIR := \
       
   101     $(shell $(CD) $(TEST_OUTPUT_DIR)/jtreg && $(PWD))
       
   102 else
       
   103   ifdef ALT_OUTPUTDIR
       
   104     ABS_OUTPUTDIR = $(shell $(CD) $(ALT_OUTPUTDIR) && $(PWD))
       
   105   else
       
   106     ABS_OUTPUTDIR = $(shell $(CD) $(TEST_ROOT)/.. && $(PWD))
       
   107   endif
       
   108 
       
   109   ABS_PLATFORM_BUILD_ROOT = $(ABS_OUTPUTDIR)
       
   110   ABS_TEST_OUTPUT_DIR := $(ABS_PLATFORM_BUILD_ROOT)/testoutput/$(UNIQUE_DIR)
       
   111 endif
       
   112 
       
   113 # Expect JPRT to set PRODUCT_HOME (the product or jdk in this case to test)
       
   114 ifndef PRODUCT_HOME
       
   115   # Try to use images/jdk if it exists
       
   116   ABS_JDK_IMAGE = $(ABS_PLATFORM_BUILD_ROOT)/images/jdk
       
   117   PRODUCT_HOME :=                               \
       
   118     $(shell                                     \
       
   119       if [ -d $(ABS_JDK_IMAGE) ] ; then         \
       
   120          $(ECHO) "$(ABS_JDK_IMAGE)";            \
       
   121        else                                     \
       
   122          $(ECHO) "$(ABS_PLATFORM_BUILD_ROOT)";  \
       
   123        fi)
       
   124   PRODUCT_HOME := $(PRODUCT_HOME)
       
   125 endif
       
   126 
       
   127 # Expect JPRT to set JAVA_ARGS (e.g. -server etc.)
       
   128 ifdef JAVA_ARGS
       
   129   JAVA_OPTIONS := $(JAVA_ARGS)
       
   130 else
       
   131   JAVA_OPTIONS :=
       
   132 endif
       
   133 
       
   134 # Expect JPRT to set JPRT_PRODUCT_ARGS (e.g. -server etc.)
       
   135 #   Should be passed into 'java' only.
       
   136 #   Could include: -d64 -server -client OR any java option
       
   137 ifdef JPRT_PRODUCT_ARGS
       
   138   JAVA_ARGS = $(JPRT_PRODUCT_ARGS)
       
   139 endif
       
   140 
       
   141 # Expect JPRT to set JPRT_PRODUCT_VM_ARGS (e.g. -Xcomp etc.)
       
   142 #   Should be passed into anything running the vm (java, javac, javadoc, ...).
       
   143 ifdef JPRT_PRODUCT_VM_ARGS
       
   144   JAVA_VM_ARGS = $(JPRT_PRODUCT_VM_ARGS)
       
   145 endif
       
   146 
       
   147 ifneq ($(NATIVE_TEST_PATH), )
       
   148   # jtreg -nativepath <dir>
       
   149   #
       
   150   # Local make tests will be TEST_IMAGE_DIR and JPRT with jprt.use.reg.test.bundle=true
       
   151   # should be JPRT_TESTNATIVE_PATH
       
   152   ifdef TEST_IMAGE_DIR
       
   153     TESTNATIVE_DIR = $(TEST_IMAGE_DIR)
       
   154   else ifdef JPRT_TESTNATIVE_PATH
       
   155     TESTNATIVE_DIR = $(JPRT_TESTNATIVE_PATH)
       
   156   endif
       
   157   ifdef TESTNATIVE_DIR
       
   158     JTREG_NATIVE_PATH = -nativepath:$(shell $(GETMIXEDPATH) "$(TESTNATIVE_DIR)/$(NATIVE_TEST_PATH)")
       
   159   endif
       
   160 endif
       
   161 
       
   162 ifeq ($(USE_FAILURE_HANDLER), true)
       
   163   # jtreg failure handler config
       
   164   ifeq ($(FAILURE_HANDLER_DIR), )
       
   165     ifneq ($(TESTNATIVE_DIR), )
       
   166       FAILURE_HANDLER_DIR := $(TESTNATIVE_DIR)/failure_handler
       
   167     endif
       
   168   endif
       
   169   ifneq ($(FAILURE_HANDLER_DIR), )
       
   170     FAILURE_HANDLER_DIR_MIXED := $(shell $(GETMIXEDPATH) "$(FAILURE_HANDLER_DIR)")
       
   171     JTREG_FAILURE_HANDLER_OPTIONS := \
       
   172         -timeoutHandlerDir:$(FAILURE_HANDLER_DIR_MIXED)/jtregFailureHandler.jar \
       
   173         -observerDir:$(FAILURE_HANDLER_DIR_MIXED)/jtregFailureHandler.jar \
       
   174         -timeoutHandler:jdk.test.failurehandler.jtreg.GatherProcessInfoTimeoutHandler \
       
   175         -observer:jdk.test.failurehandler.jtreg.GatherDiagnosticInfoObserver \
       
   176         -timeoutHandlerTimeout:0
       
   177   ifeq ($(PLATFORM), windows)
       
   178       JTREG_FAILURE_HANDLER_OPTIONS += -J-Djava.library.path="$(FAILURE_HANDLER_DIR_MIXED)"
       
   179     endif
       
   180   endif
       
   181 endif
       
   182 
       
   183 # Expect JPRT to set JPRT_ARCHIVE_BUNDLE (path to zip bundle for results)
       
   184 ifdef JPRT_ARCHIVE_BUNDLE
       
   185   ARCHIVE_BUNDLE = $(JPRT_ARCHIVE_BUNDLE)
       
   186 else
       
   187   ARCHIVE_BUNDLE = $(ABS_TEST_OUTPUT_DIR)/ARCHIVE_BUNDLE.zip
       
   188 endif
       
   189 
       
   190 # How to create the test bundle (pass or fail, we want to create this)
       
   191 #   Follow command with ";$(BUNDLE_UP_AND_EXIT)", so it always gets executed.
       
   192 ZIP_UP_RESULTS = ( $(MKDIR) -p `$(DIRNAME) $(ARCHIVE_BUNDLE)`     \
       
   193 	           && $(CD) $(ABS_TEST_OUTPUT_DIR)             \
       
   194 	           && $(CHMOD) -R a+r . \
       
   195 	           && $(ZIPEXE) -q -r $(ARCHIVE_BUNDLE) . )
       
   196 
       
   197 # important results files
       
   198 SUMMARY_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport/text/summary.txt")
       
   199 STATS_TXT_NAME = Stats.txt
       
   200 STATS_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/$(STATS_TXT_NAME)")
       
   201 RUNLIST   = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/runlist.txt")
       
   202 PASSLIST  = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/passlist.txt")
       
   203 FAILLIST  = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/faillist.txt")
       
   204 EXITCODE  = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/exitcode.txt")
       
   205 
       
   206 TESTEXIT = \
       
   207   if [ ! -s $(EXITCODE) ] ; then \
       
   208     $(ECHO) "ERROR: EXITCODE file not filled in."; \
       
   209     $(ECHO) "1" > $(EXITCODE); \
       
   210   fi ; \
       
   211   testExitCode=`$(CAT) $(EXITCODE)`; \
       
   212   $(ECHO) "EXIT CODE: $${testExitCode}"; \
       
   213   exit $${testExitCode}
       
   214 
       
   215 ifeq ($(TREAT_EXIT_CODE_1_AS_0), true)
       
   216   ADJUST_EXIT_CODE := \
       
   217   if [ $${jtregExitCode} = 1 ] ; then \
       
   218     jtregExitCode=0; \
       
   219   fi
       
   220 else
       
   221   # colon is the shell no-op
       
   222   ADJUST_EXIT_CODE := :
       
   223 endif
       
   224 
       
   225 BUNDLE_UP_AND_EXIT = \
       
   226 ( \
       
   227   jtregExitCode=$$? && \
       
   228   _summary="$(SUMMARY_TXT)"; \
       
   229   $(ADJUST_EXIT_CODE) ; \
       
   230   $(RM) -f $(STATS_TXT) $(RUNLIST) $(PASSLIST) $(FAILLIST) $(EXITCODE); \
       
   231   $(ECHO) "$${jtregExitCode}" > $(EXITCODE); \
       
   232   if [ -r "$${_summary}" ] ; then \
       
   233     $(ECHO) "Summary: $(UNIQUE_DIR)" > $(STATS_TXT); \
       
   234     $(EXPAND) $${_summary} | $(EGREP) -v ' Not run\.' > $(RUNLIST); \
       
   235     $(EGREP) ' Passed\.' $(RUNLIST) \
       
   236       | $(EGREP) -v ' Error\.' \
       
   237       | $(EGREP) -v ' Failed\.' > $(PASSLIST); \
       
   238     ( $(EGREP) ' Failed\.' $(RUNLIST); \
       
   239       $(EGREP) ' Error\.' $(RUNLIST); \
       
   240       $(EGREP) -v ' Passed\.' $(RUNLIST) ) \
       
   241       | $(SORT) | $(UNIQ) > $(FAILLIST); \
       
   242     if [ $${jtregExitCode} != 0 -o -s $(FAILLIST) ] ; then \
       
   243       $(EXPAND) $(FAILLIST) \
       
   244         | $(CUT) -d' ' -f1 \
       
   245         | $(SED) -e 's@^@FAILED: @' >> $(STATS_TXT); \
       
   246       if [ $${jtregExitCode} = 0 ] ; then \
       
   247         jtregExitCode=1; \
       
   248       fi; \
       
   249     fi; \
       
   250     runc="`$(CAT) $(RUNLIST)      | $(WC) -l | $(AWK) '{print $$1;}'`"; \
       
   251     passc="`$(CAT) $(PASSLIST)    | $(WC) -l | $(AWK) '{print $$1;}'`"; \
       
   252     failc="`$(CAT) $(FAILLIST)    | $(WC) -l | $(AWK) '{print $$1;}'`"; \
       
   253     exclc="FIXME CODETOOLS-7900176"; \
       
   254     $(ECHO) "TEST STATS: name=$(UNIQUE_DIR)  run=$${runc}  pass=$${passc}  fail=$${failc}" \
       
   255       >> $(STATS_TXT); \
       
   256   else \
       
   257     $(ECHO) "Missing file: $${_summary}" >> $(STATS_TXT); \
       
   258   fi; \
       
   259   if [ -f $(STATS_TXT) ] ; then \
       
   260     $(CAT) $(STATS_TXT); \
       
   261   fi; \
       
   262   $(ZIP_UP_RESULTS) ; \
       
   263   $(TESTEXIT) \
       
   264 )
       
   265 
       
   266 ################################################################
       
   267 
       
   268 # Prep for output
       
   269 # Change execute permissions on shared library files.
       
   270 # Files in repositories should never have execute permissions, but
       
   271 # there are some tests that have pre-built shared libraries, and these
       
   272 # windows dll files must have execute permission. Adding execute
       
   273 # permission may happen automatically on windows when using certain
       
   274 # versions of mercurial but it cannot be guaranteed. And blindly
       
   275 # adding execute permission might be seen as a mercurial 'change', so
       
   276 # we avoid adding execute permission to repository files. But testing
       
   277 # from a plain source tree needs the chmod a+rx. Applying the chmod to
       
   278 # all shared libraries not just dll files. And with CYGWIN and sshd
       
   279 # service, you may need CYGWIN=ntsec for this to work.
       
   280 prep:
       
   281 	@$(MKDIR) -p $(ABS_TEST_OUTPUT_DIR)
       
   282 	@$(MKDIR) -p `$(DIRNAME) $(ARCHIVE_BUNDLE)`
       
   283 	@if [ ! -d $(TEST_ROOT)/../.hg ] ; then                                   \
       
   284 	  $(FIND) $(TEST_ROOT) \( -name \*.dll -o -name \*.DLL -o -name \*.so \)  \
       
   285 	        -exec $(CHMOD) a+rx {} \; ;                                       \
       
   286 	fi
       
   287 
       
   288 ifeq ($(CLEAN_BEFORE_PREP), true)
       
   289 prep: clean
       
   290 
       
   291 endif
       
   292 
       
   293 # Cleanup
       
   294 clean:
       
   295 	@$(RM) -r $(ABS_TEST_OUTPUT_DIR)
       
   296 	@$(RM) $(ARCHIVE_BUNDLE)
       
   297 
       
   298 ################################################################
       
   299 
       
   300 # jtreg tests
       
   301 
       
   302 # Expect JT_HOME to be set for jtreg tests. (home for jtreg)
       
   303 ifndef JT_HOME
       
   304   JT_HOME = $(SLASH_JAVA)/re/jtreg/$(USE_JTREG_VERSION)/promoted/latest/binaries/jtreg
       
   305   ifdef JPRT_JTREG_HOME
       
   306     JT_HOME = $(JPRT_JTREG_HOME)
       
   307   endif
       
   308 endif
       
   309 
       
   310 # Problematic tests to be excluded
       
   311 PROBLEM_LISTS=$(call MixedDirs,$(wildcard ProblemList.txt closed/ProblemList.txt))
       
   312 
       
   313 # Create exclude list for this platform and arch
       
   314 ifdef NO_EXCLUDES
       
   315   JTREG_EXCLUSIONS =
       
   316 else
       
   317   JTREG_EXCLUSIONS = $(PROBLEM_LISTS:%=-exclude:%)
       
   318 endif
       
   319 
       
   320 # convert list of directories to dos paths
       
   321 define MixedDirs
       
   322 $(foreach i,$1,$(shell $(GETMIXEDPATH) "${i}"))
       
   323 endef
       
   324 
       
   325 # ------------------------------------------------------------------
       
   326 
       
   327 # When called from JPRT the TESTDIRS variable is set to the jtreg tests to run
       
   328 ifdef TESTDIRS
       
   329   TEST_SELECTION = $(TESTDIRS)
       
   330 endif
       
   331 
       
   332 ifdef CONCURRENCY
       
   333   JTREG_BASIC_OPTIONS += -concurrency:$(CONCURRENCY)
       
   334 endif
       
   335 ifdef EXTRA_JTREG_OPTIONS
       
   336   JTREG_BASIC_OPTIONS += $(EXTRA_JTREG_OPTIONS)
       
   337 endif
       
   338 
       
   339 # Default JTREG to run
       
   340 JTREG = $(JT_HOME)/bin/jtreg
       
   341 # run in agentvm/othervm mode
       
   342 JTREG_BASIC_OPTIONS += $(JTREG_VM_TYPE)
       
   343 # Only run automatic tests
       
   344 JTREG_BASIC_OPTIONS += -a
       
   345 # Always turn on assertions
       
   346 ifeq ($(USE_JTREG_ASSERT), true)
       
   347   JTREG_ASSERT_OPTION = -ea -esa
       
   348 endif
       
   349 JTREG_BASIC_OPTIONS += $(JTREG_ASSERT_OPTION)
       
   350 # jtreg verbosity setting
       
   351 # Default is to report details on all failed or error tests, times too
       
   352 JTREG_VERBOSE ?= fail,error,time
       
   353 JTREG_BASIC_OPTIONS += $(if $(JTREG_VERBOSE),-v:$(JTREG_VERBOSE))
       
   354 # Retain all files for failing tests
       
   355 JTREG_BASIC_OPTIONS += -retain:fail,error
       
   356 # Ignore tests are not run and completely silent about it
       
   357 JTREG_IGNORE_OPTION = -ignore:quiet
       
   358 JTREG_BASIC_OPTIONS += $(JTREG_IGNORE_OPTION)
       
   359 # Multiply by 4 the timeout factor
       
   360 JTREG_TIMEOUT_OPTION =  -timeoutFactor:4
       
   361 JTREG_BASIC_OPTIONS += $(JTREG_TIMEOUT_OPTION)
       
   362 ifeq ($(LIMIT_JTREG_VM_MEMORY), true)
       
   363   # Set the max memory for jtreg control vm
       
   364   JTREG_MEMORY_OPTION = -J-Xmx512m
       
   365   JTREG_BASIC_OPTIONS += $(JTREG_MEMORY_OPTION)
       
   366   # Set the max memory for jtreg target test vms
       
   367   JTREG_TESTVM_MEMORY_OPTION = -vmoption:-Xmx512m
       
   368   JTREG_TEST_OPTIONS += $(JTREG_TESTVM_MEMORY_OPTION)
       
   369 endif
       
   370 # Give tests access to JT_JAVA, see JDK-8141609
       
   371 JTREG_BASIC_OPTIONS += -e:JDK8_HOME=${JT_JAVA}
       
   372 # Set other vm and test options
       
   373 JTREG_TEST_OPTIONS = $(JAVA_ARGS:%=-javaoptions:%) $(JAVA_OPTIONS:%=-vmoption:%) $(JAVA_VM_ARGS:%=-vmoption:%)
       
   374 
       
   375 ifeq ($(IGNORE_MARKED_TESTS), true)
       
   376   # Option to tell jtreg to not run tests marked with "ignore"
       
   377   ifeq ($(PLATFORM), windows)
       
   378     JTREG_KEY_OPTION = -k:!ignore
       
   379   else
       
   380     JTREG_KEY_OPTION = -k:\!ignore
       
   381   endif
       
   382   JTREG_BASIC_OPTIONS += $(JTREG_KEY_OPTION)
       
   383 endif
       
   384 
       
   385 # Make sure jtreg exists
       
   386 ifeq ($(USE_WINDOWS_EXISTENCE_CHECK), true)
       
   387   jtreg_exists:
       
   388 	test -d $(shell $(GETMIXEDPATH) "$(JT_HOME)")
       
   389 	test -f $(shell $(GETMIXEDPATH) "$(JTREG)")
       
   390 
       
   391 else
       
   392   jtreg_exists: $(JT_HOME)
       
   393 endif
       
   394 PHONY_LIST += jtreg_exists
       
   395 
       
   396 # Run jtreg
       
   397 jtreg_tests: prep jtreg_exists $(PRODUCT_HOME)
       
   398 	(                                                                    \
       
   399 	  ( JT_HOME=$(shell $(GETMIXEDPATH) "$(JT_HOME)");                   \
       
   400 	    export JT_HOME;                                                  \
       
   401 	    $(shell $(GETMIXEDPATH) "$(JTREG)")                              \
       
   402 	      $(JTREG_BASIC_OPTIONS)                                         \
       
   403 	      -r:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport")  \
       
   404 	      -w:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTwork")    \
       
   405 	      -jdk:$(shell $(GETMIXEDPATH) "$(PRODUCT_HOME)")                \
       
   406 	      $(JTREG_NATIVE_PATH)                                           \
       
   407 	      $(JTREG_FAILURE_HANDLER_OPTIONS)                               \
       
   408 	      $(JTREG_EXCLUSIONS)                                            \
       
   409 	      $(JTREG_TEST_OPTIONS)                                          \
       
   410 	      $(TEST_SELECTION)                                              \
       
   411 	  ) ;                                                                \
       
   412 	  $(BUNDLE_UP_AND_EXIT)                                              \
       
   413 	) 2>&1 | $(TEE) $(ABS_TEST_OUTPUT_DIR)/output.txt ; $(TESTEXIT)
       
   414 
       
   415 PHONY_LIST += jtreg_tests
       
   416 
       
   417 ################################################################
       
   418 
       
   419 # Phony targets (e.g. these are not filenames)
       
   420 .PHONY: all clean prep $(PHONY_LIST)
       
   421 
       
   422 ################################################################