ghidra-master/Ghidra/Features/Base/src/test.slow/java/ghidra/framework/project/tool/ToolSaving3Test.java
/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.framework.project.tool;

import static org.junit.Assert.*;

import java.io.File;
import java.io.IOException;
import java.util.List;

import org.junit.Test;

import docking.action.DockingActionIf;
import docking.widgets.OptionDialog;
import docking.widgets.filechooser.GhidraFileChooser;
import ghidra.framework.ToolUtils;
import ghidra.framework.plugintool.PluginTool;
import utilities.util.FileUtilities;

public class ToolSaving3Test extends AbstractToolSavingTest {

	// test that with two changed tools and save both, then close both with no save prompt
	@Test
	public void testTwoToolsBothChanged_saveBoth_closeBoth() {
		PluginTool tool1 = launchTool(DEFAULT_TEST_TOOL_NAME);
		PluginTool tool2 = launchTool(DEFAULT_TEST_TOOL_NAME);

		boolean isSet = getBooleanFooOptions(tool1);
		setBooleanFooOptions(tool1, !isSet);
		setBooleanFooOptions(tool2, !isSet);

		saveTool(tool1);
		saveTool(tool2);

		// close in reverse save order and make sure nothing was overwritten
		closeToolWithNoSaveDialog(tool2);
		closeToolWithNoSaveDialog(tool1);

		PluginTool newTool = launchTool(DEFAULT_TEST_TOOL_NAME);

		assertEquals("Changed tool was not saved", !isSet, getBooleanFooOptions(newTool));
	}

	// test that with two changed tools and save one, both then close both.
	@Test
	public void testTwoToolsBothChanged_save1_closeBoth() {
		PluginTool tool1 = launchTool(DEFAULT_TEST_TOOL_NAME);
		PluginTool tool2 = launchTool(DEFAULT_TEST_TOOL_NAME);

		boolean isSet = getBooleanFooOptions(tool1);
		setBooleanFooOptions(tool1, !isSet);
		setBooleanFooOptions(tool2, !isSet);

		saveTool(tool1);

		closeToolWithNoSaveDialog(tool1);

		closeToolAndManuallySave(tool2);

		PluginTool newTool = launchTool(DEFAULT_TEST_TOOL_NAME);

		assertEquals("Changed tool was not saved", !isSet, getBooleanFooOptions(newTool));
	}

	@Test
	public void testExportDefaultTool() throws Exception {

		//
		// Verify a 'default' tool does not contain 'config state' when written
		//

		PluginTool tool1 = launchTool(DEFAULT_TEST_TOOL_NAME);
		DockingActionIf exportAction = getAction(tool1, "Export Default Tool");
		performAction(exportAction, false);

		GhidraFileChooser chooser = waitForDialogComponent(GhidraFileChooser.class);
		File exportedFile = createTempFile("ExportedDefaultTool", ToolUtils.TOOL_EXTENSION);
		chooser.setSelectedFile(exportedFile);
		waitForUpdateOnChooser(chooser);
		pressButtonByText(chooser, "Export");

		OptionDialog overwriteDialog = waitForDialogComponent(OptionDialog.class);
		pressButtonByText(overwriteDialog, "Overwrite");
		waitForCondition(() -> exportedFile.length() > 0);

		assertExportedFileDoesNotContainsLine(exportedFile, "PLUGIN_STATE");
	}

	@Test
	public void testExportedToolContainsConfigSettings() throws Exception {

		//
		// Regression test: ensure that an exported tool contains config settings
		//

		PluginTool tool1 = launchTool(DEFAULT_TEST_TOOL_NAME);
		DockingActionIf exportAction = getAction(tool1, "Export Tool");
		performAction(exportAction, false);

		GhidraFileChooser chooser = waitForDialogComponent(GhidraFileChooser.class);
		File exportedFile = createTempFile("ExportedTool", ToolUtils.TOOL_EXTENSION);
		chooser.setSelectedFile(exportedFile);
		waitForUpdateOnChooser(chooser);
		pressButtonByText(chooser, "Export");

		OptionDialog overwriteDialog = waitForDialogComponent(OptionDialog.class);
		pressButtonByText(overwriteDialog, "Overwrite");
		waitForCondition(() -> exportedFile.length() > 0);

		assertExportedFileContainsLine(exportedFile, "PLUGIN_STATE");
	}

	private void assertExportedFileContainsLine(File file, String line) throws IOException {

		List<String> exportedLines = FileUtilities.getLines(file);
		for (String fileLine : exportedLines) {
			if (fileLine.contains(line)) {
				return;
			}
		}

		fail("File text does not have a line containing '" + line + "'");
	}

	private void assertExportedFileDoesNotContainsLine(File file, String line) throws Exception {
		List<String> exportedLines = FileUtilities.getLines(file);
		for (String fileLine : exportedLines) {
			if (fileLine.contains(line)) {
				fail("File text should not have a line containing '" + line + "'");
			}
		}
	}

}
