1 /*
   2  * Copyright (c) 1999, 2014, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /* @test
  25  * @bug 4183169 8032050
  26  * @summary Minor problem with the way ReliableLog handles IOExceptions.
  27  *
  28  * @author Laird Dornin; code borrowed from Ann Wollrath
  29  *
  30  * @library ../../../testlibrary
  31  * @build TestLibrary RMID
  32  *     TestSecurityManager RegisteringActivatable ShutdownGracefully_Stub
  33  * @run main/othervm/policy=security.policy/timeout=700 ShutdownGracefully
  34  */
  35 
  36 import java.rmi.activation.*;
  37 import java.rmi.*;
  38 import java.util.Properties;
  39 import java.util.concurrent.TimeoutException;
  40 
  41 /**
  42  * The test creates an rmid with a special security manager.  After
  43  * rmid makes two registrations (which is greater than rmid's
  44  * snapshotInterval) the security manager stops allowing rmid to write
  45  * to update and snapshot log files in rmid's log directory.  The Test
  46  * registers an Activatable object twice with different group ids.
  47  * The second registration will cause rmid to have to write to a
  48  * LogFile (it causes a snapshot) and the security manager will not
  49  * allow the file write to happen.  The test makes sure that rmid
  50  * shuts down in a graceful manner without any explicit request to do
  51  * so.  The test will not exit for 400 seconds if rmid does not exit
  52  * (after that time, the test will fail).
  53  */
  54 public class ShutdownGracefully
  55     extends Activatable implements RegisteringActivatable
  56 {
  57     private static RegisteringActivatable registering = null;
  58 
  59     private final static long SHUTDOWN_TIMEOUT = 400 * 1000;
  60 
  61     public static void main(String args[]) {
  62 
  63         RMID rmid = null;
  64         // flag to show if test succeed
  65         boolean testSucceeded = false;
  66 
  67         // error message
  68         String failure = null;
  69         System.err.println("\nRegression test for bug/rfe 4183169\n");
  70 
  71         try {
  72             TestLibrary.suggestSecurityManager(
  73                 "java.rmi.RMISecurityManager");
  74 
  75             // start an rmid.
  76             RMID.removeLog();
  77             rmid = RMID.createRMID();
  78 
  79             // rmid needs to run with a security manager that
  80             // simulates a log problem; rmid should also snapshot
  81             // quickly.
  82             rmid.addOptions(new String[] {
  83                 "-Djava.security.manager=TestSecurityManager",
  84                 "-Dsun.rmi.activation.snapshotInterval=1"});
  85 
  86             //      rmid.addArguments(new String[] {
  87             //          "-C-Djava.rmi.server.logCalls=true"});
  88 
  89             rmid.start();
  90 
  91             // Ensure that activation groups run with the correct
  92             // security manager.
  93             //
  94             Properties p = new Properties();
  95             p.put("java.security.policy",
  96                   TestParams.defaultGroupPolicy);
  97             p.put("java.security.manager",
  98                   "java.lang.SecurityManager");
  99 
 100             System.err.println("activation group will be created " +
 101                                "in a new VM");
 102             ActivationGroupDesc groupDesc =
 103                 new ActivationGroupDesc(p, null);
 104             ActivationSystem system = ActivationGroup.getSystem();
 105             ActivationGroupID groupID = system.registerGroup(groupDesc);
 106 
 107             System.err.println("registering activatable");
 108             ActivationDesc desc = new ActivationDesc
 109                 (groupID, "ShutdownGracefully", null, null);
 110             registering = (RegisteringActivatable)
 111                 Activatable.register(desc);
 112 
 113             System.err.println("activate and deactivate object " +
 114                                "via method call");
 115             registering.shutdown();
 116 
 117             /*
 118              * the security manager rmid is running with will stop
 119              * rmid from writing to its log files; in 1.2.x this would
 120              * have caused rmid to have thrown a runtime exception and
 121              * continue running in an unstable state.  With the fix
 122              * for 4183169, rmid should shutdown gracefully instead.
 123              */
 124 
 125             /*
 126              * register another activatable with a new group id; rmid
 127              * should not recover from this...  I use two
 128              * registrations to more closely simulate the environment
 129              * in which the bug was found.  In java versions with out
 130              * the appropriate bug fix, rmid would hide a
 131              * NullPointerException in this circumstance.
 132              */
 133             p.put("dummyname", "dummyvalue");
 134             groupDesc = new ActivationGroupDesc(p, null);
 135             ActivationGroupID secondGroupID =
 136                 system.registerGroup(groupDesc);
 137             desc = new ActivationDesc(secondGroupID,
 138                 "ShutdownGracefully", null, null);
 139 
 140             /*
 141              * registration request is expected to be failed. succeeded case
 142              * should be recorded. And raise error after clean up  rmid.
 143              */
 144             try {
 145                 registering = (RegisteringActivatable)
 146                     Activatable.register(desc);
 147                 failure = "The registration request succeeded unexpectedly";
 148             } catch (ActivationException e) {
 149                 System.err.println("received exception from registration " +
 150                                    "call that should have failed...");
 151                 // Need wait rmid prcoess terminates.
 152                 try {
 153                     int exitCode = rmid.waitFor(SHUTDOWN_TIMEOUT);
 154                     System.err.println("RMID has exited gracefully with exitcode:" + exitCode);
 155                     rmid = null;
 156                     testSucceeded = true;
 157                 } catch (TimeoutException te) {
 158                     failure = "RMID hasn't exited gracefully in expected time";
 159                 }
 160             }
 161         } catch (Exception e) {
 162             failure = "unexpected exception " + e;
 163         } finally {
 164             if (rmid != null)
 165                 rmid.destroy();
 166         }
 167         if (!testSucceeded)
 168             TestLibrary.bomb("\nfailure: " + failure);
 169     }
 170 
 171     /**
 172      * implementation of RegisteringActivatable
 173      */
 174     public ShutdownGracefully
 175         (ActivationID id, MarshalledObject mo) throws RemoteException
 176     {
 177         // register/export anonymously
 178         super(id, 0);
 179     }
 180 
 181     /**
 182      * Deactivates the object. We need to unexport forcibly because this call
 183      * in-progress on this object, which is the same object that we are trying
 184      * to deactivate.
 185      */
 186     public void shutdown() throws Exception {
 187         Activatable.unexportObject(this, true);
 188         ActivationLibrary.deactivate(this, getID());
 189     }
 190 }