| /* |
| * Copyright (C) 2012, Marc Strapetz and others |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Distribution License v. 1.0 which is available at |
| * https://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * SPDX-License-Identifier: BSD-3-Clause |
| */ |
| package org.eclipse.jgit.storage.file; |
| |
| import static java.nio.charset.StandardCharsets.UTF_8; |
| import static org.eclipse.jgit.util.FileUtils.pathToString; |
| import static org.junit.Assert.assertArrayEquals; |
| import static org.junit.Assert.assertEquals; |
| |
| import java.io.ByteArrayOutputStream; |
| import java.io.IOException; |
| import java.io.OutputStream; |
| import java.nio.file.Files; |
| import java.nio.file.Path; |
| import java.nio.file.StandardOpenOption; |
| import java.util.StringTokenizer; |
| |
| import org.eclipse.jgit.errors.ConfigInvalidException; |
| import org.eclipse.jgit.junit.MockSystemReader; |
| import org.eclipse.jgit.util.FS; |
| import org.eclipse.jgit.util.FileUtils; |
| import org.eclipse.jgit.util.IO; |
| import org.eclipse.jgit.util.SystemReader; |
| import org.junit.After; |
| import org.junit.Before; |
| import org.junit.Test; |
| |
| public class FileBasedConfigTest { |
| |
| private static final String USER = "user"; |
| |
| private static final String NAME = "name"; |
| |
| private static final String EMAIL = "email"; |
| |
| private static final String ALICE = "Alice"; |
| |
| private static final String BOB = "Bob"; |
| |
| private static final String ALICE_EMAIL = "alice@home"; |
| |
| private static final String CONTENT1 = "[" + USER + "]\n\t" + NAME + " = " |
| + ALICE + "\n"; |
| |
| private static final String CONTENT2 = "[" + USER + "]\n\t" + NAME + " = " |
| + BOB + "\n"; |
| |
| private static final String CONTENT3 = "[" + USER + "]\n\t" + NAME + " = " |
| + ALICE + "\n" + "[" + USER + "]\n\t" + EMAIL + " = " + ALICE_EMAIL; |
| |
| private Path trash; |
| |
| @Before |
| public void setUp() throws Exception { |
| SystemReader.setInstance(new MockSystemReader()); |
| trash = Files.createTempDirectory("tmp_"); |
| FS.getFileStoreAttributes(trash.getParent()); |
| } |
| |
| @After |
| public void tearDown() throws Exception { |
| FileUtils.delete(trash.toFile(), |
| FileUtils.RECURSIVE | FileUtils.SKIP_MISSING | FileUtils.RETRY); |
| } |
| |
| @Test |
| public void testSystemEncoding() throws IOException, ConfigInvalidException { |
| final Path file = createFile(CONTENT1.getBytes(UTF_8)); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| |
| config.setString(USER, null, NAME, BOB); |
| config.save(); |
| assertArrayEquals(CONTENT2.getBytes(UTF_8), IO.readFully(file.toFile())); |
| } |
| |
| @Test |
| public void testUTF8withoutBOM() throws IOException, ConfigInvalidException { |
| final Path file = createFile(CONTENT1.getBytes(UTF_8)); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| |
| config.setString(USER, null, NAME, BOB); |
| config.save(); |
| assertArrayEquals(CONTENT2.getBytes(UTF_8), IO.readFully(file.toFile())); |
| } |
| |
| @Test |
| public void testUTF8withBOM() throws IOException, ConfigInvalidException { |
| final ByteArrayOutputStream bos1 = new ByteArrayOutputStream(); |
| bos1.write(0xEF); |
| bos1.write(0xBB); |
| bos1.write(0xBF); |
| bos1.write(CONTENT1.getBytes(UTF_8)); |
| |
| final Path file = createFile(bos1.toByteArray()); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| |
| config.setString(USER, null, NAME, BOB); |
| config.save(); |
| |
| final ByteArrayOutputStream bos2 = new ByteArrayOutputStream(); |
| bos2.write(0xEF); |
| bos2.write(0xBB); |
| bos2.write(0xBF); |
| bos2.write(CONTENT2.getBytes(UTF_8)); |
| assertArrayEquals(bos2.toByteArray(), IO.readFully(file.toFile())); |
| } |
| |
| @Test |
| public void testLeadingWhitespaces() throws IOException, ConfigInvalidException { |
| final ByteArrayOutputStream bos1 = new ByteArrayOutputStream(); |
| bos1.write(" \n\t".getBytes(UTF_8)); |
| bos1.write(CONTENT1.getBytes(UTF_8)); |
| |
| final Path file = createFile(bos1.toByteArray()); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| |
| config.setString(USER, null, NAME, BOB); |
| config.save(); |
| |
| final ByteArrayOutputStream bos2 = new ByteArrayOutputStream(); |
| bos2.write(" \n\t".getBytes(UTF_8)); |
| bos2.write(CONTENT2.getBytes(UTF_8)); |
| assertArrayEquals(bos2.toByteArray(), IO.readFully(file.toFile())); |
| } |
| |
| @Test |
| public void testIncludeAbsolute() |
| throws IOException, ConfigInvalidException { |
| final Path includedFile = createFile(CONTENT1.getBytes(UTF_8)); |
| final ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
| bos.write("[include]\npath=".getBytes(UTF_8)); |
| bos.write(pathToString(includedFile.toFile()).getBytes(UTF_8)); |
| |
| final Path file = createFile(bos.toByteArray()); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| } |
| |
| @Test |
| public void testIncludeRelativeDot() |
| throws IOException, ConfigInvalidException { |
| final Path includedFile = createFile(CONTENT1.getBytes(UTF_8), "dir1"); |
| final ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
| bos.write("[include]\npath=".getBytes(UTF_8)); |
| bos.write(("./" + includedFile.getFileName()).getBytes(UTF_8)); |
| |
| final Path file = createFile(bos.toByteArray(), "dir1"); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| } |
| |
| @Test |
| public void testIncludeRelativeDotDot() |
| throws IOException, ConfigInvalidException { |
| final Path includedFile = createFile(CONTENT1.getBytes(UTF_8), "dir1"); |
| final ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
| bos.write("[include]\npath=".getBytes(UTF_8)); |
| bos.write(("../" + includedFile.getParent().getFileName() + "/" |
| + includedFile.getFileName()).getBytes(UTF_8)); |
| |
| final Path file = createFile(bos.toByteArray(), "dir2"); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| } |
| |
| @Test |
| public void testIncludeRelativeDotDotNotFound() |
| throws IOException, ConfigInvalidException { |
| final Path includedFile = createFile(CONTENT1.getBytes(UTF_8)); |
| final ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
| bos.write("[include]\npath=".getBytes(UTF_8)); |
| bos.write(("../" + includedFile.getFileName()).getBytes(UTF_8)); |
| |
| final Path file = createFile(bos.toByteArray()); |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.load(); |
| assertEquals(null, config.getString(USER, null, NAME)); |
| } |
| |
| @Test |
| public void testIncludeWithTilde() |
| throws IOException, ConfigInvalidException { |
| final Path includedFile = createFile(CONTENT1.getBytes(UTF_8), "home"); |
| final ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
| bos.write("[include]\npath=".getBytes(UTF_8)); |
| bos.write(("~/" + includedFile.getFileName()).getBytes(UTF_8)); |
| |
| final Path file = createFile(bos.toByteArray(), "repo"); |
| final FS fs = FS.DETECTED.newInstance(); |
| fs.setUserHome(includedFile.getParent().toFile()); |
| |
| final FileBasedConfig config = new FileBasedConfig(file.toFile(), fs); |
| config.load(); |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| } |
| |
| @Test |
| public void testIncludeDontInlineIncludedLinesOnSave() |
| throws IOException, ConfigInvalidException { |
| // use a content with multiple sections and multiple key/value pairs |
| // because code for first line works different than for subsequent lines |
| final Path includedFile = createFile(CONTENT3.getBytes(UTF_8), "dir1"); |
| |
| final Path file = createFile(new byte[0], "dir2"); |
| FileBasedConfig config = new FileBasedConfig(file.toFile(), |
| FS.DETECTED); |
| config.setString("include", null, "path", |
| ("../" + includedFile.getParent().getFileName() + "/" |
| + includedFile.getFileName())); |
| |
| // just by setting the include.path, it won't be included |
| assertEquals(null, config.getString(USER, null, NAME)); |
| assertEquals(null, config.getString(USER, null, EMAIL)); |
| config.save(); |
| |
| // and it won't be included after saving |
| assertEquals(null, config.getString(USER, null, NAME)); |
| assertEquals(null, config.getString(USER, null, EMAIL)); |
| |
| final String expectedText = config.toText(); |
| assertEquals(2, |
| new StringTokenizer(expectedText, "\n", false).countTokens()); |
| |
| config = new FileBasedConfig(file.toFile(), FS.DETECTED); |
| config.load(); |
| |
| String actualText = config.toText(); |
| assertEquals(expectedText, actualText); |
| // but it will be included after (re)loading |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| assertEquals(ALICE_EMAIL, config.getString(USER, null, EMAIL)); |
| |
| config.save(); |
| |
| actualText = config.toText(); |
| assertEquals(expectedText, actualText); |
| // and of course preserved after saving |
| assertEquals(ALICE, config.getString(USER, null, NAME)); |
| assertEquals(ALICE_EMAIL, config.getString(USER, null, EMAIL)); |
| } |
| |
| private Path createFile(byte[] content) throws IOException { |
| return createFile(content, null); |
| } |
| |
| private Path createFile(byte[] content, String subdir) throws IOException { |
| Path dir = subdir != null ? trash.resolve(subdir) : trash; |
| Files.createDirectories(dir); |
| |
| Path f = Files.createTempFile(dir, getClass().getName(), null); |
| try (OutputStream os = Files.newOutputStream(f, |
| StandardOpenOption.APPEND)) { |
| os.write(content); |
| } |
| return f; |
| } |
| } |