Skip to content

Commit

Permalink
Merge pull request #1287 from jbc25/oppia-1256-disk-full-message
Browse files Browse the repository at this point in the history 
- added specific messages for unzip function errors
  • Loading branch information
@alexlittle
alexlittle committed Sep 26, 2022
2 parents 6a4bafa + 8d2c823 commit 1984175
Show file tree
Hide file tree
Showing 6 changed files with 136 additions and 77 deletions.
145 changes: 80 additions & 65 deletions ...a/testFiles/UnitTests/FileUtilsTests.java → ...ndroidTestFiles/Utils/FileUtilsTests.java
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
package testFiles.UnitTests;
package androidTestFiles.Utils;


import org.digitalcampus.mobile.learning.R;
import org.digitalcampus.oppia.exception.CourseInstallException;
import org.digitalcampus.oppia.utils.storage.FileUtils;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
Expand All @@ -21,75 +26,85 @@
import static junit.framework.Assert.assertFalse;
import static junit.framework.Assert.assertTrue;

import android.content.Context;

import androidx.test.ext.junit.runners.AndroidJUnit4;
import androidx.test.platform.app.InstrumentationRegistry;


@RunWith(AndroidJUnit4.class)
public class FileUtilsTests {

@Rule
public TemporaryFolder folder = new TemporaryFolder();

@Rule
public ExpectedException exceptionRule = ExpectedException.none();

private static final int FILES_COUNT = 5;
private Context context;

@Test
public void UnzipFiles_correctPaths(){
File zipFile;
boolean result = false;
try {
zipFile = createTestZipFile();
@Before
public void setUp() {
context = InstrumentationRegistry.getInstrumentation().getTargetContext();
}

if (zipFile != null) {
result = FileUtils.unzipFiles(zipFile.getParentFile().getAbsolutePath(),
zipFile.getName(),
zipFile.getParentFile().getAbsolutePath());
}
@Test
public void UnzipFiles_correctPaths() throws Exception {

assertTrue(result);
assertEquals(FILES_COUNT + 1, zipFile.getParentFile().listFiles().length);
File zipFile = createTestZipFile();

} catch (IOException e) {
e.printStackTrace();
if (zipFile != null) {
FileUtils.unzipFiles(context, zipFile.getParentFile().getAbsolutePath(),
zipFile.getName(),
zipFile.getParentFile().getAbsolutePath());
}

assertEquals(FILES_COUNT + 1, zipFile.getParentFile().listFiles().length);


}

@Test
public void UnzipFiles_wrongPaths(){
File zipFile;
boolean result;
try {
zipFile = createTestZipFile();
public void UnzipFiles_wrongSrcDir() throws Exception {

exceptionRule.expect(CourseInstallException.class);
exceptionRule.expectMessage(context.getString(R.string.source_dir_does_not_exist));

if (zipFile != null) {
//Source directory equals null
result = FileUtils.unzipFiles("Non_Existing_path",
zipFile.getName(),
zipFile.getParentFile().getAbsolutePath());

File zipFile = createTestZipFile();
FileUtils.unzipFiles(context, "Non_Existing_path",
zipFile.getName(),
zipFile.getParentFile().getAbsolutePath());

assertFalse(result);
}

//Source file equals null
result = FileUtils.unzipFiles(zipFile.getParentFile().getAbsolutePath(),
"Non_Existing_path",
zipFile.getParentFile().getAbsolutePath());
@Test
public void UnzipFiles_wrongSrcFile() throws Exception {

exceptionRule.expect(CourseInstallException.class);
exceptionRule.expectMessage(context.getString(R.string.source_file_does_not_exist));

assertFalse(result);
File zipFile = createTestZipFile();
FileUtils.unzipFiles(context, zipFile.getParentFile().getAbsolutePath(),
"Non_Existing_file",
zipFile.getParentFile().getAbsolutePath());

//Destination directory equals null
result = FileUtils.unzipFiles(zipFile.getParentFile().getAbsolutePath(),
zipFile.getName(),
"Non_Existing_path");
}

@Test
public void UnzipFiles_wrongDstDir() throws Exception {

assertFalse(result);
exceptionRule.expect(CourseInstallException.class);
exceptionRule.expectMessage(context.getString(R.string.dest_dir_does_not_exist));

}
File zipFile = createTestZipFile();
FileUtils.unzipFiles(context, zipFile.getParentFile().getAbsolutePath(),
zipFile.getName(),
"Non_Existing_path");

} catch (IOException e) {
e.printStackTrace();
}
}


/* @Test
public void UnzipFiles_createDir(){
File zipFile;
Expand Down Expand Up @@ -118,7 +133,7 @@ public void UnzipFiles_createDir(){


@Test
public void CleanDir_correctPath(){
public void CleanDir_correctPath() {

try {
File tempFolder = folder.newFolder("tempFolder");
Expand All @@ -132,50 +147,50 @@ public void CleanDir_correctPath(){

assertEquals(0, tempFolder.listFiles().length);

}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}
}

@Test
public void CleanDir_wrongPath(){
public void CleanDir_wrongPath() {
File tempFile = new File("tempFile");
assertTrue(FileUtils.cleanDir(tempFile));
}

@Test
public void CleanDir_fileAsArgument(){
public void CleanDir_fileAsArgument() {

try {
File tempFile = folder.newFile("tempFile.txt");

assertTrue(FileUtils.cleanDir(tempFile));

}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}
}

@Test
public void DeleteDir_correctPath(){
try{
public void DeleteDir_correctPath() {
try {
File tempFolder = folder.newFolder("tempFolder");

assertTrue(FileUtils.deleteDir(tempFolder));
}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}

}

@Test
public void DeleteDir_wrongPath(){
public void DeleteDir_wrongPath() {
File tempFile = new File("tempFile");
assertFalse(FileUtils.deleteDir(tempFile));
}

@Test
public void DirSize_correctSize(){
public void DirSize_correctSize() {
//Case when the directory does not exists
File f = new File("non_exists_dir");
assertEquals(0, FileUtils.dirSize(f));
Expand All @@ -199,14 +214,14 @@ public void DirSize_correctSize(){
}

assertEquals(text.length() * FILES_COUNT, FileUtils.dirSize(tempFolder));
}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}

}

@Test
public void CleanUp(){
public void CleanUp() {
try {
File dir = folder.newFolder("testFolder");
File zipFile = folder.newFile("zipFile.zip");
Expand All @@ -217,13 +232,13 @@ public void CleanUp(){
assertFalse(dir.exists());
assertFalse(zipFile.exists());

}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}
}

@Test
public void ReadFile_FileInputStream(){
public void ReadFile_FileInputStream() {
String text = "The quick brown fox jumps over the lazy dog";
String filename = "test_file.txt";

Expand All @@ -235,13 +250,13 @@ public void ReadFile_FileInputStream(){

FileInputStream fis = new FileInputStream(file);
assertEquals(text, FileUtils.readFile(fis));
}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}
}

@Test
public void ReadFile_String(){
public void ReadFile_String() {
String text = "The quick brown fox jumps over the lazy dog";
String filename = "test_file.txt";

Expand All @@ -252,7 +267,7 @@ public void ReadFile_String(){
fileWriter.close();

assertEquals(text, FileUtils.readFile(file.getAbsolutePath()));
}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}
}
Expand Down Expand Up @@ -296,27 +311,27 @@ private File createTestZipFile() throws IOException {

byte data[] = new byte[FileUtils.BUFFER_SIZE];

for(int i = 0; i < files.length; i++){
for (int i = 0; i < files.length; i++) {
FileInputStream fis = new FileInputStream(files[i]);
is = new BufferedInputStream(fis, FileUtils.BUFFER_SIZE);
try{
try {
ZipEntry entry = new ZipEntry(files[i].getName());
out.putNextEntry(entry);

int count;
while ((count = is.read(data, 0, FileUtils.BUFFER_SIZE)) != -1){
while ((count = is.read(data, 0, FileUtils.BUFFER_SIZE)) != -1) {
out.write(data, 0, count);
}
}catch(IOException ioe){
} catch (IOException ioe) {
ioe.printStackTrace();
}finally{
} finally {
is.close();
files[i].delete();
}
}
} catch (FileNotFoundException e) {
e.printStackTrace();
}finally{
} finally {
out.close();
}

Expand Down
8 changes: 8 additions & 0 deletions app/src/main/java/org/digitalcampus/oppia/exception/CourseInstallException.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package org.digitalcampus.oppia.exception;

public class CourseInstallException extends Exception {

public CourseInstallException(String message) {
super(message);
}
}
8 changes: 5 additions & 3 deletions app/src/main/java/org/digitalcampus/oppia/service/courseinstall/CourseInstall.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.digitalcampus.oppia.application.App;
import org.digitalcampus.oppia.application.SessionManager;
import org.digitalcampus.oppia.database.DbHelper;
import org.digitalcampus.oppia.exception.CourseInstallException;
import org.digitalcampus.oppia.exception.InvalidXMLException;
import org.digitalcampus.oppia.gamification.GamificationServiceDelegate;
import org.digitalcampus.oppia.model.CompleteCourse;
Expand Down Expand Up @@ -66,12 +67,13 @@ public static void installDownloadedCourse(Context ctx, String filename, String
long startTime = System.currentTimeMillis();

listener.onInstallProgress(1);
boolean unzipResult = FileUtils.unzipFiles(Storage.getDownloadPath(ctx), filename, tempdir.getAbsolutePath());

if (!unzipResult){
try {
FileUtils.unzipFiles(ctx, Storage.getDownloadPath(ctx), filename, tempdir.getAbsolutePath());
} catch (CourseInstallException e) {
//then was invalid zip file and should be removed
FileUtils.cleanUp(tempdir, Storage.getDownloadPath(ctx) + filename);
listener.onError(ctx.getString(R.string.error_installing_course, shortname));
listener.onError(ctx.getString(R.string.error_installing_course, shortname) + ". " + e.getMessage());
return;
}

Expand Down
2 changes: 1 addition & 1 deletion app/src/main/java/org/digitalcampus/oppia/service/courseinstall/CourseInstallerService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ private boolean downloadCourseFile(String fileUrl, String shortname, Double vers
Response response = client.newCall(request).execute();

long fileLength = response.body().contentLength();
Log.d(TAG, "Content-length: " + fileLength);
long availableStorage = Storage.getAvailableStorageSize(this);
Log.d(TAG, "sizes: Content-length: " + fileLength + ". available storage: " + availableStorage);

if (fileLength >= availableStorage){
sendBroadcast(fileUrl, ACTION_FAILED, this.getString(R.string.error_insufficient_storage_available));
Expand Down
Loading

0 comments on commit 1984175

Please sign in to comment.