public class CachingXmlDataStoreTest {
/** The character set to read UAS data */
private static final Charset CHARSET = DataStore.DEFAULT_CHARSET;
/** URL to retrieve the UAS data as XML */
private static final URL DATA_URL =
CachingXmlDataStoreTest.class.getClassLoader().getResource("uas_older.xml");
/** Corresponding default logger of this class */
private static final Logger LOG = LoggerFactory.getLogger(CachingXmlDataStoreTest.class);
/** {@link URL} that is not available */
private static final URL UNREACHABLE_URL = UrlUtil.build("http://unreachable.local/");
/** URL to retrieve the version of the UAS data */
private static final URL VERSION_URL =
CachingXmlDataStoreTest.class.getClassLoader().getResource("uas_older.version");
private static String readFile(final File file) throws IOException {
byte[] bytes = Files.toByteArray(file);
return new String(bytes, Charset.defaultCharset());
}
private DataStore fallback;
/**
* Temporary folder to cache <em>UAS data</em> in a file. Created files in this folder are
* guaranteed to be deleted when the test method finishes (whether it passes or fails).
*/
@Rule public final TemporaryFolder folder = new TemporaryFolder();
@Before
public void before() {
fallback = new TestXmlDataStore();
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_charset_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, VERSION_URL, null, fallback);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_dataUrl_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), null, VERSION_URL, CHARSET, fallback);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_fallback1_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, VERSION_URL, CHARSET, null);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_fallback2_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(DATA_URL, VERSION_URL, CHARSET, null);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_fallback3_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(folder.newFile("uas_test.xml"), null);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_file2_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(null, DATA_URL, VERSION_URL, CHARSET, fallback);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_file3_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(null, fallback);
}
@Test
public void createCachingXmlDataStore_provokeFallback() throws IOException, InterruptedException {
// create temp file
final File cache = folder.newFile("uas_temp.xml");
assertThat(readFile(cache)).isEqualTo("");
// create fallback data store
final String version = "fallback-data-version";
final DataStore fallback =
new DataStore() {
@Override
public Charset getCharset() {
return null;
}
@Override
public Data getData() {
return new DataBlueprint().version(version).build();
}
@Override
public DataReader getDataReader() {
return null;
}
@Override
public URL getDataUrl() {
return null;
}
@Override
public URL getVersionUrl() {
return null;
}
};
// create caching data store
final DataStore store =
CachingXmlDataStore.createCachingXmlDataStore(
cache, UNREACHABLE_URL, UNREACHABLE_URL, CHARSET, fallback);
assertThat(store.getData().getVersion()).isEqualTo(version);
}
@Test
public void createCachingXmlDataStore_successful() throws IOException, InterruptedException {
// create temp file
final File cache = folder.newFile("uas_temp.xml");
assertThat(readFile(cache)).isEqualTo("");
// create caching data store
final CachingXmlDataStore store =
CachingXmlDataStore.createCachingXmlDataStore(
cache, DATA_URL, VERSION_URL, CHARSET, fallback);
final UpdatingUserAgentStringParserImpl parser = new UpdatingUserAgentStringParserImpl(store);
Thread.sleep(1000l);
assertThat(readFile(cache).length() >= 721915).isTrue();
final long firstLastUpdateCheck = store.getUpdateOperation().getLastUpdateCheck();
LOG.debug("LastUpdateCheck at: " + firstLastUpdateCheck);
final long originalInterval = parser.getUpdateInterval();
// reduce the interval since testing
LOG.debug("Reducing the update interval during the test.");
parser.setUpdateInterval(1000l);
// we have to read to activate the update mechanism
parser.parse("check for updates");
Thread.sleep(3000l);
final long currentLastUpdateCheck = store.getUpdateOperation().getLastUpdateCheck();
LOG.debug("LastUpdateCheck at: " + currentLastUpdateCheck);
assertThat(firstLastUpdateCheck < currentLastUpdateCheck).isTrue();
parser.setUpdateInterval(originalInterval);
}
@Test(expected = IllegalNullArgumentException.class)
public void createCachingXmlDataStore_versionUrl_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, null, CHARSET, fallback);
}
@Test
public void findOrCreateCacheFile() {
CachingXmlDataStore.findOrCreateCacheFile().delete(); // delete if exists
File temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file does not exist
assertThat(temp.exists()).isTrue();
temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file exists
assertThat(temp.exists()).isTrue();
temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file exists
assertThat(temp.exists()).isTrue();
temp.delete();
assertThat(temp.exists()).isFalse();
}
}
public class CachingXmlDataStoreTest {
/** The character set to read UAS data */
private static final Charset CHARSET = DataStore.DEFAULT_CHARSET;
/** URL to retrieve the UAS data as XML */
private static final URL DATA_URL =
CachingXmlDataStoreTest.class.getClassLoader().getResource("uas_older.xml");
/** Corresponding default logger of this class */
private static final Logger LOG = LoggerFactory.getLogger(CachingXmlDataStoreTest.class);
/** {@link URL} that is not available */
private static final URL UNREACHABLE_URL = UrlUtil.build("http://unreachable.local/");
/** URL to retrieve the version of the UAS data */
private static final URL VERSION_URL =
CachingXmlDataStoreTest.class.getClassLoader().getResource("uas_older.version");
private static String readFile(final File file) throws IOException {
final FileInputStream stream = new FileInputStream(file);
try {
final FileChannel fc = stream.getChannel();
final MappedByteBuffer bb = fc.map(FileChannel.MapMode.READ_ONLY, 0, fc.size());
/* Instead of using default, pass in a decoder. */
return Charset.defaultCharset().decode(bb).toString();
} finally {
stream.close();
}
}
/**
* Temporary folder to cache <em>UAS data</em> in a file. Created files in this folder are
* guaranteed to be deleted when the test method finishes (whether it passes or fails).
*/
@Rule public final TemporaryFolder folder = new TemporaryFolder();
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_charset_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, VERSION_URL, null, Data.EMPTY);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_dataUrl_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), null, VERSION_URL, CHARSET, Data.EMPTY);
}
@Test
public void createCachingXmlDataStore_defaultCacheFile_successful()
throws IOException, InterruptedException {
// create caching data store
final CachingXmlDataStore store =
CachingXmlDataStore.createCachingXmlDataStore(DATA_URL, VERSION_URL, CHARSET);
final UpdatingUserAgentStringParserImpl parser = new UpdatingUserAgentStringParserImpl(store);
parser.parse("test");
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_fallback1_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, VERSION_URL, CHARSET, null);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_fallback2_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(DATA_URL, VERSION_URL, CHARSET, null);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_fallback3_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(folder.newFile("uas_test.xml"), null);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_file1_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(null, DATA_URL, VERSION_URL, CHARSET);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_file2_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(null, DATA_URL, VERSION_URL, CHARSET, Data.EMPTY);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_file3_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(null, Data.EMPTY);
}
@Test
public void createCachingXmlDataStore_provokeFallback() throws IOException, InterruptedException {
// create temp file
final File cache = folder.newFile("uas_temp.xml");
Assert.assertEquals("", readFile(cache));
// create caching data store
final String version = "fallback-data-version";
final DataStore store =
CachingXmlDataStore.createCachingXmlDataStore(
cache,
UNREACHABLE_URL,
UNREACHABLE_URL,
CHARSET,
DataBlueprint.buildEmptyTestData(version));
Assert.assertEquals(version, store.getData().getVersion());
}
@Test
public void createCachingXmlDataStore_successful() throws IOException, InterruptedException {
// create temp file
final File cache = folder.newFile("uas_temp.xml");
Assert.assertEquals("", readFile(cache));
// create caching data store
final CachingXmlDataStore store =
CachingXmlDataStore.createCachingXmlDataStore(cache, DATA_URL, VERSION_URL, CHARSET);
final UpdatingUserAgentStringParserImpl parser = new UpdatingUserAgentStringParserImpl(store);
Assert.assertTrue(readFile(cache).length() >= 721915);
final long firstLastUpdateCheck = parser.getUpdater().getLastUpdateCheck();
LOG.debug("LastUpdateCheck at: " + firstLastUpdateCheck);
final long originalInterval = parser.getUpdateInterval();
// reduce the interval since testing
LOG.debug("Reducing the update interval during the test.");
parser.setUpdateInterval(100l);
// we have to read to activate the update mechanism
parser.parse("check for updates");
Thread.sleep(1000l);
final long currentLastUpdateCheck = parser.getUpdater().getLastUpdateCheck();
LOG.debug("LastUpdateCheck at: " + currentLastUpdateCheck);
Assert.assertTrue(firstLastUpdateCheck < currentLastUpdateCheck);
parser.setUpdateInterval(originalInterval);
}
@Test(expected = IllegalArgumentException.class)
public void createCachingXmlDataStore_versionUrl_null() throws IOException {
CachingXmlDataStore.createCachingXmlDataStore(
folder.newFile("uas_test.xml"), DATA_URL, null, CHARSET, Data.EMPTY);
}
@Test(expected = IllegalArgumentException.class)
public void createTemporaryFile_null() {
CachingXmlDataStore.createTemporaryFile(null);
}
@Test
public void deleteFile_doesNotExist() throws IOException {
final File cache = folder.newFile(); // cache file does not exist
CachingXmlDataStore.deleteFile(cache);
}
@Test(expected = IllegalStateException.class)
public void deleteFile_existsButDeletingFails()
throws IOException, SecurityException, NoSuchMethodException {
final File file = folder.newFile(); // cache file does not exist
final IMockBuilder<File> builder = EasyMock.createMockBuilder(File.class);
builder.withConstructor(URI.class);
builder.withArgs(file.toURI());
builder.addMockedMethod(File.class.getMethod("exists"));
builder.addMockedMethod(File.class.getMethod("delete"));
final File fileMock = builder.createMock();
EasyMock.expect(fileMock.exists()).andReturn(true).anyTimes();
EasyMock.expect(fileMock.delete()).andReturn(false).anyTimes();
EasyMock.replay(fileMock);
CachingXmlDataStore.deleteFile(fileMock);
EasyMock.verify(fileMock);
}
@Test(expected = IllegalArgumentException.class)
public void deleteFile_null() {
CachingXmlDataStore.deleteFile(null);
}
@Test
public void deleteFile_successful() throws IOException, SecurityException, NoSuchMethodException {
final File file = folder.newFile(); // cache file does not exist
final IMockBuilder<File> builder = EasyMock.createMockBuilder(File.class);
builder.withConstructor(URI.class);
builder.withArgs(file.toURI());
builder.addMockedMethod(File.class.getMethod("exists"));
builder.addMockedMethod(File.class.getMethod("delete"));
final File fileMock = builder.createMock();
EasyMock.expect(fileMock.exists()).andReturn(true).anyTimes();
EasyMock.expect(fileMock.delete()).andReturn(true).anyTimes();
EasyMock.replay(fileMock);
CachingXmlDataStore.deleteFile(fileMock);
EasyMock.verify(fileMock);
}
@Test
public void findOrCreateCacheFile() {
CachingXmlDataStore.findOrCreateCacheFile().delete(); // delete if exists
File temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file does not exist
temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file exists
temp = CachingXmlDataStore.findOrCreateCacheFile(); // cache file exists
temp.delete();
}
@Test(expected = IllegalArgumentException.class)
public void readAndSave_charset_null() throws IOException {
final File cache = folder.newFile(); // cache file does not exist
CachingXmlDataStore.readAndSave(DATA_URL, cache, null);
}
@Test(expected = IllegalArgumentException.class)
public void readAndSave_dataUrl_null() throws IOException {
final File cache = folder.newFile(); // cache file does not exist
CachingXmlDataStore.readAndSave(null, cache, CHARSET);
}
@Test
public void readAndSave_deleteAndRenameTempFileTest() throws MalformedURLException, IOException {
final File cache = folder.newFile(); // cache file does not exist
// Assert.assertTrue(temp.length() == 0); // does not work on any system
Assert.assertTrue(FileUtil.isEmpty(cache, DataStore.DEFAULT_CHARSET));
// file will be created
CachingXmlDataStore.readAndSave(DATA_URL, cache, CHARSET);
Assert.assertTrue(cache.length() >= 722015);
// file will be overwritten (delete and rename)
CachingXmlDataStore.readAndSave(DATA_URL, cache, CHARSET);
Assert.assertTrue(cache.length() >= 722015);
}
@Test(expected = IllegalArgumentException.class)
public void readAndSave_file_null() throws IOException {
CachingXmlDataStore.readAndSave(DATA_URL, null, CHARSET);
}
@Test
public void readAndSave_renamingFailsTest() throws MalformedURLException, IOException {
final File cache = folder.newFile(); // cache file does not exist
final IMockBuilder<File> builder = EasyMock.createMockBuilder(File.class);
builder.withConstructor(URI.class);
builder.withArgs(cache.toURI());
final File fileMock = builder.addMockedMethod("renameTo", File.class).createMock();
EasyMock.expect(fileMock.renameTo(EasyMock.anyObject(File.class))).andReturn(false).anyTimes();
EasyMock.replay(fileMock);
// Assert.assertTrue(temp.length() == 0); // does not work on any system
Assert.assertTrue(FileUtil.isEmpty(fileMock, DataStore.DEFAULT_CHARSET));
// file will be created
CachingXmlDataStore.readAndSave(DATA_URL, fileMock, CHARSET);
Assert.assertTrue(fileMock.length() >= 722015);
// file will be overwritten (delete and rename)
CachingXmlDataStore.readAndSave(DATA_URL, fileMock, CHARSET);
Assert.assertTrue(fileMock.length() >= 722015);
}
@Test
public void readAndSave_urlAndFileAreSameResource() throws MalformedURLException, IOException {
final File resource = folder.newFile(); // cache file does not exist
CachingXmlDataStore.readAndSave(resource.toURI().toURL(), resource, CHARSET);
}
@Test(expected = IllegalArgumentException.class)
public void renameFile_from_null() throws IOException {
CachingXmlDataStore.renameFile(null, folder.newFile());
}
@Test(expected = IllegalArgumentException.class)
public void renameFile_fromFileDoesNotExist()
throws MalformedURLException, IOException, SecurityException, NoSuchMethodException {
final File from = folder.newFile(); // cache file does not exist
final IMockBuilder<File> builder = EasyMock.createMockBuilder(File.class);
builder.withConstructor(URI.class);
builder.withArgs(from.toURI());
builder.addMockedMethod(File.class.getMethod("exists"));
final File fileMock = builder.createMock();
EasyMock.expect(fileMock.exists()).andReturn(false).anyTimes();
EasyMock.replay(fileMock);
CachingXmlDataStore.renameFile(fileMock, folder.newFile());
EasyMock.verify(fileMock);
}
@Test(expected = IllegalStateException.class)
public void renameFile_removingOrphanedFileTest()
throws MalformedURLException, IOException, SecurityException, NoSuchMethodException {
final File from = folder.newFile(); // cache file does not exist
final IMockBuilder<File> builder = EasyMock.createMockBuilder(File.class);
builder.withConstructor(URI.class);
builder.withArgs(from.toURI());
builder.addMockedMethod(File.class.getMethod("exists"));
builder.addMockedMethod(File.class.getMethod("renameTo", File.class));
final File fileMock = builder.createMock();
// final File fileMock = builder.addMockedMethod("exists").addMockedMethod("renameTo",
// File.class).createMock();
EasyMock.expect(fileMock.exists()).andReturn(true).anyTimes();
EasyMock.expect(fileMock.renameTo(EasyMock.anyObject(File.class))).andReturn(false).anyTimes();
EasyMock.replay(fileMock);
CachingXmlDataStore.renameFile(fileMock, folder.newFile());
EasyMock.verify(fileMock);
}
@Test(expected = IllegalArgumentException.class)
public void renameFile_to_null() throws IOException {
CachingXmlDataStore.renameFile(folder.newFile(), null);
}
}