@Test(
dataProvider = "basicInfo",
dependsOnMethods = {"testExecuteNoAction"},
alwaysRun = true)
public void testActionDoesNotAllowChangingArticlesInCsv(
ArticleList articleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
// execute the action to get the original csv
action.setListKey(articleList.getListKey());
action.execute();
String originalCsv = action.getArticleOrderCSV();
String changedCsv = originalCsv.substring(originalCsv.indexOf(",") + 1);
changedCsv = "id:this-article-was-not-in-original-csv," + changedCsv;
assertEquals(
changedCsv.split(",").length,
originalCsv.split(",").length,
"test added or removed articles instead of just changing one");
action.setCommand("UPDATE_LIST");
action.setArticleOrderCSV(changedCsv);
action.setDisplayName(articleList.getDisplayName());
// should fail
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertTrue(action.getActionErrors().size() > 0, "Action didn't return error messages");
}
@Test(
dataProvider = "basicInfo",
dependsOnMethods = {"testExecuteNoAction"},
alwaysRun = true)
public void testActionDoesNotAllowRemovingArticleFromCsv(
ArticleList articleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
// execute the action to get the original csv
action.setListKey(articleList.getListKey());
action.execute();
String originalCsv = action.getArticleOrderCSV();
String articleToRemove = originalCsv.substring(0, originalCsv.indexOf(","));
String incorrectCsv = originalCsv.replace(articleToRemove + ",", "");
action.setCommand("UPDATE_LIST");
action.setArticleOrderCSV(incorrectCsv);
action.setDisplayName(articleList.getDisplayName());
// should fail
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertTrue(action.getActionErrors().size() > 0, "Action didn't return error messages");
}
@Test(
dataProvider = "basicInfo",
dependsOnMethods = {"testExecuteNoAction"},
alwaysRun = true)
public void testRemoveArticles(
ArticleList articleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
// delete first three dois
List<Article> articlesToDelete =
dummyDataStore.get(ArticleList.class, articleList.getID()).getArticles().subList(0, 3);
String[] articlesToDeleteArray = new String[3];
for (int i = 0; i < 3; i++) {
articlesToDeleteArray[i] = articlesToDelete.get(i).getDoi();
}
action.setCommand("REMOVE_ARTICLES");
action.setListKey(articleList.getListKey());
action.setArticlesToRemove(articlesToDeleteArray);
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertEquals(action.getActionErrors().size(), 0, "Action returned error messages");
assertEquals(
action.getActionMessages().size(), 1, "Action didn't return messages indicating success");
for (Article article : articlesToDelete) {
String doi = article.getDoi();
assertFalse(
getDois(action.getArticleList().getArticles()).contains(doi),
"Article " + doi + " didn't get removed from action's article list");
assertFalse(
action.getArticleOrderCSV().contains(doi),
"Article " + doi + " didn't get removed from action's csv");
}
// check the values in the db
List<Article> storedArticleList =
dummyDataStore.get(ArticleList.class, articleList.getID()).getArticles();
for (Article article : articlesToDelete) {
String doi = article.getDoi();
assertFalse(
getDois(storedArticleList).contains(doi),
"Article " + doi + " didn't get removed from list in the database");
try {
articleService.getArticle(doi, DEFAULT_ADMIN_AUTHID);
} catch (NoSuchArticleIdException e) {
fail(
"Article "
+ doi
+ " got deleted from the database instead of just being removed from the list");
}
}
}
@Test(
dataProvider = "basicInfo",
dependsOnMethods = {"testExecuteNoAction", "testUpdateArticleList"},
alwaysRun = true)
public void testAddArticle(
ArticleList articleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
String articlesToAddCsv = "id:new-article-for-adding-1,id:new-article-for-adding-2";
for (String doi : articlesToAddCsv.split(",")) {
Article article = new Article();
article.setDoi(doi);
article.setTitle("New article for adding");
dummyDataStore.store(article);
}
action.setCommand("ADD_ARTICLE");
action.setListKey(articleList.getListKey());
action.setArticlesToAddCsv(articlesToAddCsv);
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertEquals(action.getActionErrors().size(), 0, "Action returned error messages");
assertEquals(
action.getActionMessages().size(), 1, "Action didn't return messages indicating success");
for (String doi : articlesToAddCsv.split(",")) {
assertTrue(
action.getArticleOrderCSV().contains(doi),
"Article " + doi + " didn't get added to action's csv");
assertTrue(
getDois(action.getArticleList().getArticles()).contains(doi),
"Article " + doi + " didn't get added to action's articleList");
}
// check the values that got stored to the database
List<Article> storedArticles =
dummyDataStore.get(ArticleList.class, articleList.getID()).getArticles();
for (String doi : articlesToAddCsv.split(",")) {
assertTrue(
getDois(storedArticles).contains(doi),
"Article " + doi + " didn't get added to the list in the database");
}
}
@Test(dataProvider = "basicInfo")
public void testExecuteNoAction(
ArticleList expectedArticleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
action.setListKey(expectedArticleList.getListKey());
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertEquals(action.getActionErrors().size(), 0, "Action returned error messages");
assertEquals(
action.getActionMessages().size(), 0, "Action returned messages on default request");
ArticleList actualArticleList = action.getArticleList();
assertEquals(
actualArticleList.getListKey(),
expectedArticleList.getListKey(),
"Action returned incorrect issue");
assertEquals(
actualArticleList.getDisplayName(),
expectedArticleList.getDisplayName(),
"Action returned issue with incorrect display name");
assertEquals(
actualArticleList.getArticles(),
expectedArticleList.getArticles(),
"Action returned wrong Dois in articleList");
assertEquals(
Arrays.asList(action.getArticleOrderCSV().split(",")),
getDois(expectedArticleList.getArticles()),
"Action returned different articleOrderCSV");
// the action should show the article csv in order of the valid articles
assertEquals(
isSorted(action.getArticleOrderCSV().split(","), indices),
true,
"Action returned unsorted articles");
for (ArticleInfo articleInfo : action.getArticleInfoList()) {
String doi = articleInfo.getDoi();
assertEquals(
validDois.contains(doi), true, "Action returned orphan articles in articleInfoList");
}
}
@DataProvider(name = "basicInfo")
public Object[][] getBasicInfo() {
dummyDataStore.deleteAll(Article.class);
dummyDataStore.deleteAll(ArticleList.class);
Map<String, Integer> indices = new HashMap<String, Integer>();
Set<String> validDois = new HashSet<String>();
Set<String> orphanDois = new HashSet<String>();
ArticleList articleList = new ArticleList();
articleList.setListType(ArticleManagementAction.ARTICLE_LIST_TYPE);
articleList.setListKey("id:testArticleListForArticleManagement");
articleList.setDisplayName("News");
int articlesCount = 8;
articleList.setArticles(new ArrayList<Article>());
for (int i = 0; i < articlesCount; i++) {
String doi;
// two articles are invalid at index 3 and 4
if (i != 3 && i != 4) {
doi = "id:valid-article-" + i;
Article article = new Article();
article.setDoi(doi);
article.setTitle("Title for Valid Article " + i);
dummyDataStore.store(article);
articleList.getArticles().add(article);
validDois.add(doi);
} else {
doi = "id:orphan-article-" + i;
orphanDois.add(doi);
}
indices.put(doi, i);
}
dummyDataStore.store(articleList);
return new Object[][] {{articleList, indices, validDois, orphanDois}};
}
@Test(
dataProvider = "basicInfo",
dependsOnMethods = {"testExecuteNoAction"},
alwaysRun = true)
public void testUpdateArticleList(
ArticleList articleList,
Map<String, Integer> indices,
Set<String> validDois,
Set<String> orphanDois)
throws Exception {
// execute the action to get the current CSV
action.setCommand("foo");
action.setListKey(articleList.getListKey());
action.execute();
clearMessages();
List<Article> existingArticles =
dummyDataStore.get(ArticleList.class, articleList.getID()).getArticles();
// move first doi to last in reorder
String reorderedArticleCsv = action.getArticleOrderCSV();
String articleToReorder = reorderedArticleCsv.substring(0, reorderedArticleCsv.indexOf(","));
reorderedArticleCsv = reorderedArticleCsv.replaceFirst(articleToReorder + ",", "");
reorderedArticleCsv += ("," + articleToReorder);
List<String> orderedArticlesForDb = Arrays.asList(reorderedArticleCsv.split(","));
Map<String, Integer> newIndices = new HashMap<String, Integer>();
for (int i = 0; i < orderedArticlesForDb.size(); ++i) {
newIndices.put(orderedArticlesForDb.get(i), i);
}
String displayName = "Spam";
action.setCommand("UPDATE_LIST");
action.setListKey(articleList.getListKey());
action.setArticleOrderCSV(reorderedArticleCsv);
action.setDisplayName(displayName);
String result = action.execute();
assertEquals(result, Action.SUCCESS, "Action didn't return success");
assertEquals(action.getActionErrors().size(), 0, "Action returned error messages");
assertTrue(
action.getActionMessages().size() > 0, "Action didn't return messages indicating success");
// check properties on action
assertEquals(
action.getArticleList().getListKey(),
articleList.getListKey(),
"action changed article list after update");
assertEquals(action.getDisplayName(), displayName, "action had incorrect display name");
assertEquals(
getDois(action.getArticleList().getArticles()),
orderedArticlesForDb,
"Action returned wrong Dois in articleList");
assertEquals(
action.getArticleOrderCSV(),
reorderedArticleCsv,
"Action returned different articleOrderCSV");
// the action should show the article csv in order of the valid articles
assertEquals(
isSorted(action.getArticleOrderCSV().split(","), newIndices),
true,
"Action returned wrong order after update articles");
for (ArticleInfo articleInfo : action.getArticleInfoList()) {
String doi = articleInfo.getDoi();
assertEquals(
validDois.contains(doi), true, "Action returned orphan articles in articleInfoList");
}
// check what got stored to the database
ArticleList storedArticleList = dummyDataStore.get(ArticleList.class, articleList.getID());
assertEquals(
storedArticleList.getDisplayName(),
displayName,
"Article List got saved to the database with incorrect display name");
assertEqualsNoOrder(
storedArticleList.getArticles().toArray(),
existingArticles.toArray(),
"Articles got removed or added from the list on reordering");
}