1 /*
   2  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
   3  * 
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * The contents of this file are subject to the terms of either the Universal Permissive License
   7  * v 1.0 as shown at http://oss.oracle.com/licenses/upl
   8  *
   9  * or the following license:
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification, are permitted
  12  * provided that the following conditions are met:
  13  * 
  14  * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
  15  * and the following disclaimer.
  16  * 
  17  * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
  18  * conditions and the following disclaimer in the documentation and/or other materials provided with
  19  * the distribution.
  20  * 
  21  * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
  22  * endorse or promote products derived from this software without specific prior written permission.
  23  * 
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  26  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  31  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 package org.openjdk.jmc.rjmx.test.services;
  34 
  35 import static org.junit.Assert.assertNotNull;
  36 
  37 import org.junit.Test;
  38 import org.openjdk.jmc.rjmx.ConnectionDescriptorBuilder;
  39 import org.openjdk.jmc.rjmx.IConnectionDescriptor;
  40 import org.openjdk.jmc.rjmx.IConnectionHandle;
  41 import org.openjdk.jmc.rjmx.IServerHandle;
  42 import org.openjdk.jmc.rjmx.services.IDiagnosticCommandService;
  43 import org.openjdk.jmc.rjmx.services.IOperation;
  44 import org.openjdk.jmc.rjmx.test.RjmxTestCase;
  45 
  46 /**
  47  * This test suite is supposed to test the example code that we ship with the documentation for the
  48  * org.openjdk.jmc.rjmx bundle. That is, for each code example included in
  49  * org.openjdk.jmc.rjmx/src/org/openjdk/jmc/rjmx/services/package.html, there should be a test
  50  * method in here with a verbatim copy of that code.
  51  * <p>
  52  * Included in the ServicesTestSuite.
  53  */
  54 // NOTE: If you change the verbatim test YOU MUST update the corresponding package.html document.
  55 public class ServicesPackageExampleTest extends RjmxTestCase {
  56         public void packageExampleFunctionalityVerbatim() throws Exception {
  57                 IConnectionDescriptor descriptor = new ConnectionDescriptorBuilder().hostName("localhost").port(0).build(); //$NON-NLS-1$
  58                 IServerHandle handle = IServerHandle.create(descriptor);
  59                 try {
  60                         IConnectionHandle connection = handle.connect("Run Diagnostic commands"); //$NON-NLS-1$
  61                         assumeHasDiagnosticCommandsService(connection);
  62                         IDiagnosticCommandService dcmd = connection.getServiceOrThrow(IDiagnosticCommandService.class);
  63                         for (IOperation operation : dcmd.getOperations()) {
  64                                 System.out.println(dcmd.runCtrlBreakHandlerWithResult(String.format("help %s", operation.getName()))); //$NON-NLS-1$
  65                         }
  66                 } finally {
  67                         handle.dispose();
  68                 }
  69         }
  70 
  71         @Test
  72         public void testPackageExampleFunctionality() throws Exception {
  73                 IConnectionDescriptor descriptor = new ConnectionDescriptorBuilder().hostName("localhost").port(0).build(); //$NON-NLS-1$
  74                 IServerHandle handle = IServerHandle.create(descriptor);
  75                 try {
  76                         IConnectionHandle connection = handle.connect("Run Diagnostic commands"); //$NON-NLS-1$
  77                         assumeHasDiagnosticCommandsService(connection);
  78                         IDiagnosticCommandService dcmd = connection.getServiceOrThrow(IDiagnosticCommandService.class);
  79                         for (IOperation operation : dcmd.getOperations()) {
  80                                 String command = operation.getName();
  81                                 assertNotNull("Could not retrieve help for the command: " + command, //$NON-NLS-1$
  82                                                 dcmd.runCtrlBreakHandlerWithResult(String.format("help %s", command))); //$NON-NLS-1$
  83                         }
  84                 } finally {
  85                         handle.dispose();
  86                 }
  87         }
  88 }