Back to Repositories

Testing DefaultContentMetadata Operations in SmartTube

This test suite evaluates the DefaultContentMetadata class in ExoPlayer’s caching system, focusing on metadata management functionality. The tests verify storage, retrieval, and manipulation of different metadata types including strings, integers, and byte arrays, ensuring robust content metadata handling.

Test Coverage Overview

The test suite provides comprehensive coverage of DefaultContentMetadata operations:
  • Basic metadata operations (contains, get, set)
  • Multiple data type handling (strings, integers, byte arrays)
  • Mutation operations (add, edit, remove)
  • Edge cases like empty metadata and mutation combinations
  • Equality comparison tests

Implementation Analysis

The testing approach uses JUnit with AndroidJUnit4 runner for Android-specific testing context. Tests follow AAA pattern (Arrange-Act-Assert) with Truth assertion library for improved readability. Each test method focuses on a specific metadata operation, using helper methods for test data creation.

Technical Details

Testing tools and configuration:
  • JUnit 4 framework with AndroidJUnit4 runner
  • Google Truth assertion library
  • Custom helper method createContentMetadata for test data setup
  • ContentMetadataMutations for metadata modifications

Best Practices Demonstrated

The test suite exemplifies several testing best practices:
  • Clear test method naming that describes the scenario being tested
  • Proper test isolation using @Before setup
  • Comprehensive verification of both positive and negative scenarios
  • Efficient test data creation through helper methods
  • Thorough validation of object equality and hash code consistency

yuliskov/smarttube

exoplayer-amzn-2.10.6/library/core/src/test/java/com/google/android/exoplayer2/upstream/cache/DefaultContentMetadataTest.java

            
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.android.exoplayer2.upstream.cache;

import static com.google.common.truth.Truth.assertThat;

import androidx.test.ext.junit.runners.AndroidJUnit4;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

/** Tests {@link DefaultContentMetadata}. */
@RunWith(AndroidJUnit4.class)
public class DefaultContentMetadataTest {

  private DefaultContentMetadata contentMetadata;

  @Before
  public void setUp() throws Exception {
    contentMetadata = createContentMetadata();
  }

  @Test
  public void testContainsReturnsFalseWhenEmpty() throws Exception {
    assertThat(contentMetadata.contains("test metadata")).isFalse();
  }

  @Test
  public void testContainsReturnsTrueForInitialValue() throws Exception {
    contentMetadata = createContentMetadata("metadata name", "value");
    assertThat(contentMetadata.contains("metadata name")).isTrue();
  }

  @Test
  public void testGetReturnsDefaultValueWhenValueIsNotAvailable() throws Exception {
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("default value");
  }

  @Test
  public void testGetReturnsInitialValue() throws Exception {
    contentMetadata = createContentMetadata("metadata name", "value");
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("value");
  }

  @Test
  public void testEmptyMutationDoesNotFail() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    DefaultContentMetadata.EMPTY.copyWithMutationsApplied(mutations);
  }

  @Test
  public void testAddNewMetadata() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.set("metadata name", "value");
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("value");
  }

  @Test
  public void testAddNewIntMetadata() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.set("metadata name", 5);
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", 0)).isEqualTo(5);
  }

  @Test
  public void testAddNewByteArrayMetadata() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    byte[] value = {1, 2, 3};
    mutations.set("metadata name", value);
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", new byte[] {})).isEqualTo(value);
  }

  @Test
  public void testNewMetadataNotWrittenBeforeCommitted() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.set("metadata name", "value");
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("default value");
  }

  @Test
  public void testEditMetadata() throws Exception {
    contentMetadata = createContentMetadata("metadata name", "value");
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.set("metadata name", "edited value");
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("edited value");
  }

  @Test
  public void testRemoveMetadata() throws Exception {
    contentMetadata = createContentMetadata("metadata name", "value");
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.remove("metadata name");
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("default value");
  }

  @Test
  public void testAddAndRemoveMetadata() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.set("metadata name", "value");
    mutations.remove("metadata name");
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("default value");
  }

  @Test
  public void testRemoveAndAddMetadata() throws Exception {
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    mutations.remove("metadata name");
    mutations.set("metadata name", "value");
    contentMetadata = contentMetadata.copyWithMutationsApplied(mutations);
    assertThat(contentMetadata.get("metadata name", "default value")).isEqualTo("value");
  }

  @Test
  public void testEqualsStringValues() throws Exception {
    DefaultContentMetadata metadata1 = createContentMetadata("metadata1", "value");
    DefaultContentMetadata metadata2 = createContentMetadata("metadata1", "value");
    assertThat(metadata1).isEqualTo(metadata2);
  }

  @Test
  public void testEquals() throws Exception {
    DefaultContentMetadata metadata1 =
        createContentMetadata(
            "metadata1", "value", "metadata2", 12345, "metadata3", new byte[] {1, 2, 3});
    DefaultContentMetadata metadata2 =
        createContentMetadata(
            "metadata2", 12345, "metadata3", new byte[] {1, 2, 3}, "metadata1", "value");
    assertThat(metadata1).isEqualTo(metadata2);
    assertThat(metadata1.hashCode()).isEqualTo(metadata2.hashCode());
  }

  @Test
  public void testNotEquals() throws Exception {
    DefaultContentMetadata metadata1 = createContentMetadata("metadata1", new byte[] {1, 2, 3});
    DefaultContentMetadata metadata2 = createContentMetadata("metadata1", new byte[] {3, 2, 1});
    assertThat(metadata1).isNotEqualTo(metadata2);
    assertThat(metadata1.hashCode()).isNotEqualTo(metadata2.hashCode());
  }

  private DefaultContentMetadata createContentMetadata(Object... pairs) {
    assertThat(pairs.length % 2).isEqualTo(0);
    ContentMetadataMutations mutations = new ContentMetadataMutations();
    for (int i = 0; i < pairs.length; i += 2) {
      String name = (String) pairs[i];
      Object value = pairs[i + 1];
      if (value instanceof String) {
        mutations.set(name, (String) value);
      } else if (value instanceof byte[]) {
        mutations.set(name, (byte[]) value);
      } else if (value instanceof Number) {
        mutations.set(name, ((Number) value).longValue());
      } else {
        throw new IllegalArgumentException();
      }
    }
    return DefaultContentMetadata.EMPTY.copyWithMutationsApplied(mutations);
  }
}