app/src/test/java/com/amaze/filemanager/filesystem/compressed/CompressedHelperTest.java

/*
 * Copyright (C) 2014-2024 Arpit Khurana <arpitkh96@gmail.com>, Vishal Nehra <vishalmeham2@gmail.com>,
 * Emmanuel Messulam<emmanuelbendavid@gmail.com>, Raymond Lai <airwave209gt at gmail.com> and Contributors.
 *
 * This file is part of Amaze File Manager.
 *
 * Amaze File Manager is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.amaze.filemanager.filesystem.compressed;

import static android.os.Build.VERSION_CODES.LOLLIPOP;
import static android.os.Build.VERSION_CODES.P;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import java.io.File;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.annotation.Config;

import com.amaze.filemanager.BuildConfig;
import com.amaze.filemanager.asynchronous.management.ServiceWatcherUtil;
import com.amaze.filemanager.fileoperations.utils.UpdatePosition;
import com.amaze.filemanager.filesystem.compressed.extractcontents.Extractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.RarExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.SevenZipExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.TarBzip2Extractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.TarExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.TarGzExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.TarLzmaExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.TarXzExtractor;
import com.amaze.filemanager.filesystem.compressed.extractcontents.helpers.ZipExtractor;
import com.amaze.filemanager.filesystem.compressed.showcontents.Decompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.RarDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.SevenZipDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.TarBzip2Decompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.TarDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.TarGzDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.TarLzmaDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.TarXzDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.UnknownCompressedFileDecompressor;
import com.amaze.filemanager.filesystem.compressed.showcontents.helpers.ZipDecompressor;
import com.amaze.filemanager.shadows.ShadowMultiDex;

import android.content.Context;
import android.os.Build;

import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;

@RunWith(AndroidJUnit4.class)
@Config(
    shadows = {ShadowMultiDex.class},
    sdk = {LOLLIPOP, P, Build.VERSION_CODES.R})
public class CompressedHelperTest {

  private Context context;
  private Extractor.OnUpdate emptyUpdateListener;

  @Before
  public void setUp() {
    context = ApplicationProvider.getApplicationContext();
    emptyUpdateListener =
        new Extractor.OnUpdate() {
          @Override
          public void onStart(long totalBytes, String firstEntryName) {}

          @Override
          public void onUpdate(String entryPath) {}

          @Override
          public void onFinish() {}

          @Override
          public boolean isCancelled() {
            return false;
          }
        };
  }

  /**
   * Extractor check This program use 6 extension and 4 extractor. Check if each extensions matched
   * correct extractor
   */
  @Test
  public void getExtractorInstance() {
    UpdatePosition updatePosition = ServiceWatcherUtil.UPDATE_POSITION;

    File file = new File("/test/test.zip"); // .zip used by ZipExtractor
    Extractor result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), ZipExtractor.class);
    file = new File("/test/test.jar"); // .jar used by ZipExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), ZipExtractor.class);
    file = new File("/test/test.apk"); // .apk used by ZipExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), ZipExtractor.class);
    file = new File("/test/test.tar"); // .tar used by TarExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarExtractor.class);
    file = new File("/test/test.tar.gz"); // .tar.gz used by GzipExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarGzExtractor.class);
    file = new File("/test/test.tgz"); // .tgz used by GzipExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarGzExtractor.class);
    if (BuildConfig.FLAVOR == "play") {
      file = new File("/test/test.rar"); // .rar used by RarExtractor
      result =
          CompressedHelper.getExtractorInstance(
              context, file, "/test2", emptyUpdateListener, updatePosition);
      assertEquals(result.getClass(), RarExtractor.class);
    }
    file = new File("/test/test.tar.bz2"); // .rar used by RarExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarBzip2Extractor.class);
    file = new File("/test/test.tbz"); // .rar used by RarExtractor
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarBzip2Extractor.class);
    file = new File("/test/test.7z");
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), SevenZipExtractor.class);
    file = new File("/test/test.tar.xz");
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarXzExtractor.class);
    file = new File("/test/test.tar.lzma");
    result =
        CompressedHelper.getExtractorInstance(
            context, file, "/test2", emptyUpdateListener, updatePosition);
    assertEquals(result.getClass(), TarLzmaExtractor.class);
  }

  /**
   * Decompressor check This program use 6 extension and 4 decompressor. Check if each extensions
   * matched correct decompressor
   */
  @Test
  public void getCompressorInstance() {
    File file = new File("/test/test.zip"); // .zip used by ZipDecompressor
    Decompressor result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), ZipDecompressor.class);
    file = new File("/test/test.jar"); // .jar used by ZipDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), ZipDecompressor.class);
    file = new File("/test/test.apk"); // .apk used by ZipDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), ZipDecompressor.class);
    file = new File("/test/test.tar"); // .tar used by TarDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarDecompressor.class);
    file = new File("/test/test.tar.gz"); // .tar.gz used by GzipDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarGzDecompressor.class);
    file = new File("/test/test.tgz"); // .tar.gz used by GzipDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarGzDecompressor.class);
    if (BuildConfig.FLAVOR == "play") {
      file = new File("/test/test.rar"); // .rar used by RarDecompressor
      result = CompressedHelper.getCompressorInstance(context, file);
      assertEquals(result.getClass(), RarDecompressor.class);
    }
    file = new File("/test/test.tar.bz2"); // .tar.bz2 used by TarBzip2Decompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarBzip2Decompressor.class);
    file = new File("/test/test.tbz"); // .tbz used by TarBzip2Decompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarBzip2Decompressor.class);
    file = new File("/test/test.7z"); // Can't use 7zip
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), SevenZipDecompressor.class);
    file = new File("/test/test.tar.xz"); // .tar.xz used by TarXzDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarXzDecompressor.class);
    file = new File("/test/test.tar.lzma"); // .tar.lzma used by TarLzmaDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), TarLzmaDecompressor.class);
    file = new File("/test/test.txt.gz"); // .gz used by UnknownCompressedFileDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), UnknownCompressedFileDecompressor.class);
    file = new File("/test/test.txt.bz2"); // .bz2 used by UnknownCompressedFileDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), UnknownCompressedFileDecompressor.class);
    file = new File("/test/test.txt.lzma"); // .lzma used by UnknownCompressedFileDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), UnknownCompressedFileDecompressor.class);
    file = new File("/test/test.txt.xz"); // .xz used by UnknownCompressedFileDecompressor
    result = CompressedHelper.getCompressorInstance(context, file);
    assertEquals(result.getClass(), UnknownCompressedFileDecompressor.class);
  }

  /** isFileExtractable() fuction test extension check */
  @Test
  public void isFileExtractableTest() throws Exception {
    // extension in code. So, it return true
    assertTrue(CompressedHelper.isFileExtractable("/test/test.zip"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.rar"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tar"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tar.gz"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tgz"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tar.bz2"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tbz"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.tar.lzma"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.jar"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.apk"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.7z"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.txt.gz"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.txt.bz2"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.txt.lzma"));
    assertTrue(CompressedHelper.isFileExtractable("/test/test.txt.xz"));

    // extension not in code. So, it return false
    assertFalse(CompressedHelper.isFileExtractable("/test/test.z"));
  }

  /**
   * getFileName() function test it return file name. But, if it is invalid compressed file, return
   * file name with extension
   */
  @Test
  public void getFileNameTest() throws Exception {
    assertEquals("test", CompressedHelper.getFileName("test.zip"));
    assertEquals("test", CompressedHelper.getFileName("test.rar"));
    assertEquals("test", CompressedHelper.getFileName("test.tar"));
    assertEquals("test", CompressedHelper.getFileName("test.tar.gz"));
    assertEquals("test", CompressedHelper.getFileName("test.tgz"));
    assertEquals("test", CompressedHelper.getFileName("test.tar.bz2"));
    assertEquals("test", CompressedHelper.getFileName("test.tbz"));
    assertEquals("test", CompressedHelper.getFileName("test.tar.lzma"));
    assertEquals("test", CompressedHelper.getFileName("test.jar"));
    assertEquals("test", CompressedHelper.getFileName("test.apk"));
    assertEquals("test", CompressedHelper.getFileName("test.7z"));

    assertEquals("test.txt", CompressedHelper.getFileName("test.txt.gz"));
    assertEquals("test.txt", CompressedHelper.getFileName("test.txt.bz2"));
    assertEquals("test.txt", CompressedHelper.getFileName("test.txt.lzma"));
    assertEquals("test.txt", CompressedHelper.getFileName("test.txt.xz"));

    // no extension(directory)
    assertEquals("test", CompressedHelper.getFileName("test"));

    // invalid extension
    assertEquals("test.z", CompressedHelper.getFileName("test.z"));

    // no path
    assertEquals("", CompressedHelper.getFileName(""));
  }
}