/*
 * Copyright (c) 2002, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package nsk.jdi.Scenarios.invokeMethod;

import nsk.share.*;
import nsk.share.jpda.*;
import nsk.share.jdi.*;
import jdk.test.lib.Utils;

import com.sun.jdi.*;
import com.sun.jdi.request.*;
import com.sun.jdi.event.*;

import java.util.*;
import java.io.*;

/**
 * This test based on a scenario which consists of the following steps:
 *     1. Invoking debugee's static method by <code>ClassType.invokeMethod()</code>.<br>
 *     2. Redefinition of this method.                                              <br>
 *     3. Invoking the one again.                                                   <br>
 *
 * The test checks a value of static field to be equal to new value.
 * When the field has unexpected value, the test fails.
 */

public class redefineclasses001 {

    public final static String UNEXPECTED_STRING = "***Unexpected exception ";

    private final static String prefix = "nsk.jdi.Scenarios.invokeMethod.";
    private final static String debuggerName = prefix + "redefineclasses001";
    public final static String debugeeName = debuggerName + "a";
    public final static String testedClassName = debuggerName + "b";

    private final static String classFileName = "redefineclasses001b.class";

    private static int exitStatus;
    private static Log log;
    private static Debugee debugee;
    private static long waitTime;
    private static String classDir;

    public final static int expectedEventCount = redefineclasses001a.brkpLineNumber.length;
    private int eventCount = 0;
    private ReferenceType debugeeClass;

    private static void display(String msg) {
        log.display(msg);
    }

    private static void complain(String msg) {
        log.complain(msg + "\n");
    }

    public static void main(String argv[]) {
        int result = run(argv,System.out);
        if (result != 0) {
            throw new RuntimeException("TEST FAILED with result " + result);
        }
    }

    public static int run(String argv[], PrintStream out) {

        exitStatus = Consts.TEST_PASSED;

        redefineclasses001 thisTest = new redefineclasses001();

        ArgumentHandler argHandler = new ArgumentHandler(argv);
        log = new Log(out, argHandler);

        classDir = argv[0];
        waitTime = argHandler.getWaitTime() * 60000;

        Binder binder = new Binder(argHandler, log);
        debugee = binder.bindToDebugee(debugeeName);
        debugee.redirectOutput(log);

        try {
            thisTest.execTest();
        } catch (Throwable e) {
            exitStatus = Consts.TEST_FAILED;
            e.printStackTrace();
        } finally {
            debugee.endDebugee();
        }
        display("Test finished. exitStatus = " + exitStatus);

        return exitStatus;
    }

    private void execTest() throws Failure {

        if (!debugee.VM().canRedefineClasses()) {
            display("\n>>>canRedefineClasses() is false<<< test canceled.\n");
            return;
        }

        display("\nTEST BEGINS");
        display("===========");

        EventSet eventSet = null;
        EventIterator eventIterator = null;
        Event event;
        long totalTime = waitTime;
        long tmp, begin = System.currentTimeMillis(),
             delta = 0;
        boolean exit = false;

        EventRequestManager evm = debugee.getEventRequestManager();
        ClassPrepareRequest req = evm.createClassPrepareRequest();
        req.addClassFilter(debugeeName);
        req.enable();
        debugee.resume();

        while (totalTime > 0 && !exit) {
            if (eventIterator == null || !eventIterator.hasNext()) {
                try {
                    eventSet = debugee.VM().eventQueue().remove(totalTime);
                } catch (InterruptedException e) {
                    new Failure(e);
                }
                if (eventSet != null) {
                    eventIterator = eventSet.eventIterator();
                } else {
                    eventIterator = null;
                }
            }
            if (eventIterator != null) {
                while (eventIterator.hasNext()) {
                    event = eventIterator.nextEvent();
//                    display("\nevent ===>>> " + event);

                    if (event instanceof ClassPrepareEvent) {
                        display("\nevent ===>>> " + event);
                        prepareTestCases();
                        debugee.resume();

                    } else if (event instanceof BreakpointEvent) {
                        display("\nevent ===>>> " + event);
                        event.request().disable();
                        display("\n\n==================");
                        display(eventCount + "-case");
                        performCase(eventCount, ((BreakpointEvent )event).thread());
                        eventCount++;
                        if (eventCount < expectedEventCount) prepareTestCases();

                        debugee.resume();

                    } else if (event instanceof VMDeathEvent) {
                        exit = true;
                        break;
                    } else if (event instanceof VMDisconnectEvent) {
                        exit = true;
                        break;
                    } // if
                } // while
            } // if
            tmp = System.currentTimeMillis();
            delta = tmp - begin;
            totalTime -= delta;
                begin = tmp;
        }

        if (totalTime <= 0) {
            complain("out of wait time...");
            exitStatus = Consts.TEST_FAILED;
        }
        if (eventCount != expectedEventCount) {
            complain("expecting " + expectedEventCount
                        + " events, but "
                        + eventCount + " events arrived.");
            exitStatus = Consts.TEST_FAILED;
        }

        display("=============");
        display("TEST FINISHES\n");
    }

    private void performCase(int num, ThreadReference thread) {
        ClassType testedClass = (ClassType )debugee.classByName(testedClassName);
        invokeMethod(testedClass, redefineclasses001b.methodName,
                        thread);
        checkFieldVal(testedClass, redefineclasses001b.flagName,
                        redefineclasses001b.BEFORE_REDEFINITION);

        display("\nredefining...");
        String newClassFile = classDir + File.separator
                    + "newclass" + File.separator
                    + prefix.replace('.',File.separatorChar)
                    + classFileName;
        redefineDebugee(testedClass, newClassFile);

        invokeMethod(testedClass, redefineclasses001b.methodName,
                        thread);
        checkFieldVal(testedClass, redefineclasses001b.flagName,
                        redefineclasses001b.AFTER_REDEFINITION);

        display("\nreturning the previous state...");
        redefineDebugee(testedClass,
                ClassFileFinder.findClassFile(testedClassName, Utils.TEST_CLASS_PATH)
                               .toString());
    }

    private void redefineDebugee(ReferenceType refType, String classFileName) {
        Map<? extends com.sun.jdi.ReferenceType,byte[]> mapBytes;
        boolean alreadyComplained = false;
        mapBytes = mapClassToBytes(refType, classFileName);
        try {
            debugee.VM().redefineClasses(mapBytes);
        } catch (Exception e) {
            throw new Failure(UNEXPECTED_STRING + e);
        }
    }

    private Map<? extends com.sun.jdi.ReferenceType,byte[]> mapClassToBytes(ReferenceType refType, String fileName) {
        display("class-file\t:" + fileName);
        File fileToBeRedefined = new File(fileName);
        int fileToRedefineLength = (int )fileToBeRedefined.length();
        byte[] arrayToRedefine = new byte[fileToRedefineLength];

        FileInputStream inputFile;
        try {
            inputFile = new FileInputStream(fileToBeRedefined);
        } catch (FileNotFoundException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        }

        try {
            inputFile.read(arrayToRedefine);
            inputFile.close();
        } catch (IOException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        }
        HashMap<ReferenceType,byte[]> mapForClass = new HashMap<com.sun.jdi.ReferenceType,byte[]>();
        mapForClass.put(refType, arrayToRedefine);
        return mapForClass;
    }

    private void prepareTestCases() {
        debugeeClass = debugee.classByName(debugeeName);
        display("\npreparing the next testcase...");
        display("debugeeClass\t\t:" + debugeeClass.name());
        display("line number:\t" + redefineclasses001a.brkpLineNumber[eventCount]);
        display("setting breakpoint...");
        debugee.setBreakpoint(debugeeClass,
                                redefineclasses001a.brkpMethodName,
                                redefineclasses001a.brkpLineNumber[eventCount]);
    }

    private void invokeMethod(ClassType clsType, String methodName,
                                ThreadReference thread) {
        Method mthd = debugee.methodByName(clsType, methodName);
        display("\ninvoking method\t:\"" + mthd.name() + "\"");
        display("-------------------------------");
        Vector<Value> args = new Vector<Value>();
        args.add(debugee.VM().mirrorOf(false));
        try {
            clsType.invokeMethod(thread, mthd, args, 0);
        } catch (InvalidTypeException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        } catch (ClassNotLoadedException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        } catch (IncompatibleThreadStateException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        } catch (InvocationException e) {
            throw new Failure(UNEXPECTED_STRING + e);
        }
    }

    private boolean checkFieldVal(ReferenceType refType, String fieldName,
                                    int expectedValue) {
        display("checking flag's value");
        Field fld = refType.fieldByName(fieldName);
        PrimitiveValue val = (PrimitiveValue )refType.getValue(fld);
        if (val.intValue() == expectedValue) {
            display("The field has expected value:\t"
                        + redefineclasses001b.flag2String(expectedValue));
            return true;
        } else {
            complain("The field has value:\t"
                        + redefineclasses001b.flag2String(val.intValue()));
            complain("but it is expected:\t"
                        + redefineclasses001b.flag2String(expectedValue));
            exitStatus = Consts.TEST_FAILED;

            return false;
        }
    }
}