/*
* Copyright 2000-2017 JetBrains s.r.o.
*
* 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 com.intellij.updater;
import com.intellij.openapi.util.SystemInfo;
import com.intellij.openapi.util.io.FileUtil;
import org.junit.Test;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.channels.FileLock;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
public class PatchCreationTest extends PatchTestCase {
@Test
public void testDigestFiles() throws Exception {
Patch patch = createPatch();
Map<String, Long> checkSums = patch.digestFiles(myOlderDir, Collections.emptyList(), false, TEST_UI);
assertThat(checkSums.size()).isEqualTo(11);
}
@Test
public void testBasics() throws Exception {
Patch patch = createPatch();
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "bin/idea.bat", CHECKSUMS.IDEA_BAT),
new CreateAction(patch, "newDir/"),
new CreateAction(patch, "newDir/newFile.txt"),
new UpdateAction(patch, "Readme.txt", CHECKSUMS.README_TXT),
new UpdateZipAction(patch, "lib/annotations.jar",
Collections.singletonList("org/jetbrains/annotations/NewClass.class"),
Collections.singletonList("org/jetbrains/annotations/Nullable.class"),
Collections.singletonList("org/jetbrains/annotations/TestOnly.class"),
CHECKSUMS.ANNOTATIONS_JAR),
new UpdateZipAction(patch, "lib/bootstrap.jar",
Collections.emptyList(),
Collections.emptyList(),
Collections.singletonList("com/intellij/ide/ClassloaderUtil.class"),
CHECKSUMS.BOOTSTRAP_JAR));
}
@Test
public void testCreatingWithIgnoredFiles() throws Exception {
PatchSpec spec = new PatchSpec()
.setOldFolder(myOlderDir.getAbsolutePath())
.setNewFolder(myNewerDir.getAbsolutePath())
.setIgnoredFiles(Arrays.asList("Readme.txt", "bin/idea.bat"));
Patch patch = new Patch(spec, TEST_UI);
assertThat(sortActions(patch.getActions())).containsExactly(
new CreateAction(patch, "newDir/"),
new CreateAction(patch, "newDir/newFile.txt"),
new UpdateZipAction(patch, "lib/annotations.jar",
Collections.singletonList("org/jetbrains/annotations/NewClass.class"),
Collections.singletonList("org/jetbrains/annotations/Nullable.class"),
Collections.singletonList("org/jetbrains/annotations/TestOnly.class"),
CHECKSUMS.ANNOTATIONS_JAR),
new UpdateZipAction(patch, "lib/bootstrap.jar",
Collections.emptyList(),
Collections.emptyList(),
Collections.singletonList("com/intellij/ide/ClassloaderUtil.class"),
CHECKSUMS.BOOTSTRAP_JAR));
}
@Test
public void testValidation() throws Exception {
Patch patch = createPatch();
FileUtil.writeToFile(new File(myOlderDir, "bin/idea.bat"), "changed");
FileUtil.createDirectory(new File(myOlderDir, "extraDir"));
FileUtil.writeToFile(new File(myOlderDir, "extraDir/extraFile.txt"), "");
FileUtil.createDirectory(new File(myOlderDir, "newDir"));
FileUtil.writeToFile(new File(myOlderDir, "newDir/newFile.txt"), "");
FileUtil.writeToFile(new File(myOlderDir, "Readme.txt"), "changed");
FileUtil.writeToFile(new File(myOlderDir, "lib/annotations.jar"), "changed");
FileUtil.delete(new File(myOlderDir, "lib/bootstrap.jar"));
assertThat(sortResults(patch.validate(myOlderDir, TEST_UI))).containsExactly(
new ValidationResult(ValidationResult.Kind.CONFLICT,
"bin/idea.bat",
ValidationResult.Action.DELETE,
ValidationResult.MODIFIED_MESSAGE,
ValidationResult.Option.DELETE, ValidationResult.Option.KEEP),
new ValidationResult(ValidationResult.Kind.CONFLICT,
"newDir/",
ValidationResult.Action.CREATE,
ValidationResult.ALREADY_EXISTS_MESSAGE,
ValidationResult.Option.REPLACE, ValidationResult.Option.KEEP),
new ValidationResult(ValidationResult.Kind.CONFLICT,
"newDir/newFile.txt",
ValidationResult.Action.CREATE,
ValidationResult.ALREADY_EXISTS_MESSAGE,
ValidationResult.Option.REPLACE, ValidationResult.Option.KEEP),
new ValidationResult(ValidationResult.Kind.ERROR,
"Readme.txt",
ValidationResult.Action.UPDATE,
ValidationResult.MODIFIED_MESSAGE,
ValidationResult.Option.IGNORE),
new ValidationResult(ValidationResult.Kind.ERROR,
"lib/annotations.jar",
ValidationResult.Action.UPDATE,
ValidationResult.MODIFIED_MESSAGE,
ValidationResult.Option.IGNORE),
new ValidationResult(ValidationResult.Kind.ERROR,
"lib/bootstrap.jar",
ValidationResult.Action.UPDATE,
ValidationResult.ABSENT_MESSAGE,
ValidationResult.Option.IGNORE));
}
@Test
public void testValidatingCaseOnlyRename() throws Exception {
Patch patch = createCaseOnlyRenamePatch();
assertThat(patch.validate(myOlderDir, TEST_UI)).isEmpty();
}
@Test
public void testValidatingCaseOnlyRenameWithConflict() throws Exception {
assertThat(Runner.isCaseSensitiveFs()).isEqualTo(SystemInfo.isFileSystemCaseSensitive);
Patch patch = createCaseOnlyRenamePatch();
FileUtil.writeToFile(new File(myOlderDir, "bin/IDEA.bat"), FileUtil.loadFileBytes(new File(myOlderDir, "bin/idea.bat")));
List<ValidationResult> results = patch.validate(myOlderDir, TEST_UI);
if (SystemInfo.isFileSystemCaseSensitive) {
assertThat(results).containsExactly(
new ValidationResult(ValidationResult.Kind.CONFLICT,
"bin/IDEA.bat",
ValidationResult.Action.CREATE,
ValidationResult.ALREADY_EXISTS_MESSAGE,
ValidationResult.Option.REPLACE, ValidationResult.Option.KEEP));
}
else {
assertThat(results).isEmpty();
}
}
@Test
public void testValidationWithOptionalFiles() throws Exception {
Patch patch1 = createPatch();
FileUtil.copy(new File(myOlderDir, "lib/boot.jar"), new File(myOlderDir, "lib/annotations.jar"));
assertThat(patch1.validate(myOlderDir, TEST_UI)).containsExactly(
new ValidationResult(ValidationResult.Kind.ERROR,
"lib/annotations.jar",
ValidationResult.Action.UPDATE,
ValidationResult.MODIFIED_MESSAGE,
ValidationResult.Option.IGNORE));
PatchSpec spec = new PatchSpec()
.setOldFolder(myOlderDir.getAbsolutePath())
.setNewFolder(myNewerDir.getAbsolutePath())
.setOptionalFiles(Collections.singletonList("lib/annotations.jar"));
Patch patch2 = new Patch(spec, TEST_UI);
FileUtil.delete(new File(myOlderDir, "lib/annotations.jar"));
assertThat(patch2.validate(myOlderDir, TEST_UI)).isEmpty();
}
@Test
public void testValidatingNonAccessibleFiles() throws Exception {
Patch patch = createPatch();
File f = new File(myOlderDir, "Readme.txt");
try (FileOutputStream s = new FileOutputStream(f, true); FileLock ignored = s.getChannel().lock()) {
String message = UtilsTest.IS_WINDOWS
? System.getProperty("java.vm.name").contains("OpenJDK")
? "Locked by: OpenJDK Platform binary"
: "Locked by: Java(TM) Platform SE binary"
: ValidationResult.ACCESS_DENIED_MESSAGE;
ValidationResult.Option option = UtilsTest.IS_WINDOWS ? ValidationResult.Option.KILL_PROCESS : ValidationResult.Option.IGNORE;
assertThat(patch.validate(myOlderDir, TEST_UI)).containsExactly(
new ValidationResult(ValidationResult.Kind.ERROR,
"Readme.txt",
ValidationResult.Action.UPDATE,
message,
option));
}
}
@Test
public void testZipFileMove() throws Exception {
resetNewerDir();
FileUtil.rename(new File(myNewerDir, "lib/annotations.jar"), new File(myNewerDir, "lib/redist/annotations.jar"));
Patch patch = createPatch();
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "lib/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR),
new CreateAction(patch, "lib/redist/"),
new UpdateAction(patch, "lib/redist/annotations.jar", "lib/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR, true));
}
@Test
public void testZipFileMoveWithUpdate() throws Exception {
resetNewerDir();
FileUtil.delete(new File(myNewerDir, "lib/annotations.jar"));
FileUtil.copy(new File(dataDir, "lib/annotations_changed.jar"), new File(myNewerDir, "lib/redist/annotations.jar"));
Patch patch = createPatch();
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "lib/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR),
new CreateAction(patch, "lib/redist/"),
new UpdateZipAction(patch, "lib/redist/annotations.jar", "lib/annotations.jar",
Collections.singletonList("org/jetbrains/annotations/NewClass.class"),
Collections.singletonList("org/jetbrains/annotations/Nullable.class"),
Collections.singletonList("org/jetbrains/annotations/TestOnly.class"),
CHECKSUMS.ANNOTATIONS_JAR));
}
@Test
public void testZipFileMoveWithAlternatives() throws Exception {
FileUtil.copy(new File(myOlderDir, "lib/annotations.jar"), new File(myOlderDir, "lib64/annotations.jar"));
resetNewerDir();
FileUtil.rename(new File(myNewerDir, "lib/annotations.jar"), new File(myNewerDir, "lib/redist/annotations.jar"));
FileUtil.rename(new File(myNewerDir, "lib64/annotations.jar"), new File(myNewerDir, "lib64/redist/annotations.jar"));
Patch patch = createPatch();
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "lib/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR),
new DeleteAction(patch, "lib64/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR),
new CreateAction(patch, "lib/redist/"),
new CreateAction(patch, "lib64/redist/"),
new UpdateAction(patch, "lib/redist/annotations.jar", "lib/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR, true),
new UpdateAction(patch, "lib64/redist/annotations.jar", "lib64/annotations.jar", CHECKSUMS.ANNOTATIONS_JAR, true));
}
@Test
public void testNoOptionalFileMove1() throws Exception {
resetNewerDir();
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myOlderDir, "lib/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations_changed.jar"), new File(myOlderDir, "lib64/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myNewerDir, "lib/redist/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myNewerDir, "lib64/redist/annotations.bin"));
Patch patch = createPatch(spec -> spec.setOptionalFiles(Arrays.asList("lib/annotations.bin", "lib/redist/annotations.bin")));
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "lib/annotations.bin", CHECKSUMS.ANNOTATIONS_JAR_BIN),
new DeleteAction(patch, "lib64/annotations.bin", CHECKSUMS.ANNOTATIONS_CHANGED_JAR_BIN),
new CreateAction(patch, "lib/redist/"),
new CreateAction(patch, "lib64/redist/"),
new UpdateAction(patch, "lib/redist/annotations.bin", "lib/annotations.bin", CHECKSUMS.ANNOTATIONS_JAR_BIN, true),
new UpdateAction(patch, "lib64/redist/annotations.bin", "lib64/annotations.bin", CHECKSUMS.ANNOTATIONS_CHANGED_JAR_BIN, false));
}
@Test
public void testNoOptionalFileMove2() throws Exception {
resetNewerDir();
FileUtil.copy(new File(dataDir, "lib/annotations_changed.jar"), new File(myOlderDir, "lib/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myOlderDir, "lib64/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myNewerDir, "lib/redist/annotations.bin"));
FileUtil.copy(new File(dataDir, "lib/annotations.jar"), new File(myNewerDir, "lib64/redist/annotations.bin"));
Patch patch = createPatch(spec -> spec.setOptionalFiles(Arrays.asList("lib/annotations.bin", "lib/redist/annotations.bin")));
assertThat(sortActions(patch.getActions())).containsExactly(
new DeleteAction(patch, "lib/annotations.bin", CHECKSUMS.ANNOTATIONS_CHANGED_JAR_BIN),
new DeleteAction(patch, "lib64/annotations.bin", CHECKSUMS.ANNOTATIONS_JAR_BIN),
new CreateAction(patch, "lib/redist/"),
new CreateAction(patch, "lib64/redist/"),
new UpdateAction(patch, "lib/redist/annotations.bin", "lib64/annotations.bin", CHECKSUMS.ANNOTATIONS_JAR_BIN, true),
new UpdateAction(patch, "lib64/redist/annotations.bin", "lib64/annotations.bin", CHECKSUMS.ANNOTATIONS_JAR_BIN, true));
}
@Test
public void testSaveLoad() throws Exception {
Patch original = createPatch();
File f = getTempFile("file");
try (FileOutputStream out = new FileOutputStream(f)) {
original.write(out);
}
Patch recreated;
try (FileInputStream in = new FileInputStream(f)) {
recreated = new Patch(in);
}
assertThat(recreated.getActions()).isEqualTo(original.getActions());
}
private Patch createCaseOnlyRenamePatch() throws IOException, OperationCancelledException {
Patch patch = createPatch();
assertThat(patch.getActions().get(0))
.isInstanceOf(DeleteAction.class)
.hasFieldOrPropertyWithValue("path", "bin/idea.bat");
patch.getActions().add(1, new CreateAction(patch, "bin/IDEA.bat")); // simulates rename "idea.bat" -> "IDEA.bat"
return patch;
}
}