src/main/java/com/google/android/libraries/feed/feedstore/testing/AbstractClearableFeedStoreTest.java

// Copyright 2018 The Feed Authors.
//
// 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.libraries.feed.feedstore.testing;

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

import com.google.android.libraries.feed.api.common.ActionPropertiesWithId;
import com.google.android.libraries.feed.api.common.PayloadWithId;
import com.google.android.libraries.feed.api.common.SemanticPropertiesWithId;
import com.google.android.libraries.feed.api.store.LocalActionMutation.ActionType;
import com.google.android.libraries.feed.common.Result;
import com.google.android.libraries.feed.common.concurrent.testing.ClockBackedFakeMainThreadRunner;
import com.google.android.libraries.feed.feedstore.internal.ClearableStore;
import com.google.android.libraries.feed.host.storage.CommitResult;
import com.google.protobuf.ByteString;
import com.google.search.now.feed.client.StreamDataProto.StreamFeature;
import com.google.search.now.feed.client.StreamDataProto.StreamLocalAction;
import com.google.search.now.feed.client.StreamDataProto.StreamPayload;
import com.google.search.now.feed.client.StreamDataProto.StreamSharedState;
import com.google.search.now.feed.client.StreamDataProto.StreamStructure;
import com.google.search.now.wire.feed.OpaqueActionDataForTestProto.OpaqueActionDataForTest;
import com.google.search.now.wire.feed.OpaqueActionDataProto.OpaqueActionData;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.junit.Test;

/** Tests of the {@link ClearableStore} classes. */
public abstract class AbstractClearableFeedStoreTest extends AbstractFeedStoreTest {

  protected static final String CONTENT_ID = "CONTENT_ID";
  protected static final String CONTENT_ID_2 = "CONTENT_ID_2";
  protected static final String SESSION_ID = "SESSION";
  protected static final String SESSION_ID_2 = "SESSION_2";
  protected static final StreamPayload STREAM_PAYLOAD =
      StreamPayload.newBuilder()
          .setStreamFeature(StreamFeature.newBuilder().setContentId(CONTENT_ID))
          .build();
  protected static final StreamPayload STREAM_PAYLOAD_2 =
      StreamPayload.newBuilder()
          .setStreamFeature(StreamFeature.newBuilder().setContentId(CONTENT_ID_2))
          .build();
  protected static final StreamPayload STREAM_PAYLOAD_SHARED_STATE =
      StreamPayload.newBuilder()
          .setStreamSharedState(StreamSharedState.newBuilder().setContentId(CONTENT_ID))
          .build();
  protected static final StreamPayload STREAM_PAYLOAD_SHARED_STATE_2 =
      StreamPayload.newBuilder()
          .setStreamSharedState(StreamSharedState.newBuilder().setContentId(CONTENT_ID_2))
          .build();
  protected static final byte[] SEMANTIC_PROPERTIES = new byte[] {14, 23, 54, 7};
  protected static final byte[] SEMANTIC_PROPERTIES_2 = new byte[] {12, 24, 18, 9};
  protected static final OpaqueActionData ACTION_PROPERTIES =
      OpaqueActionData.newBuilder()
          .setExtension(
              OpaqueActionDataForTest.opaqueActionDataForTestExtension,
              OpaqueActionDataForTest.newBuilder().setId(CONTENT_ID).build())
          .build();
  protected static final OpaqueActionData ACTION_PROPERTIES_2 =
      OpaqueActionData.newBuilder()
          .setExtension(
              OpaqueActionDataForTest.opaqueActionDataForTestExtension,
              OpaqueActionDataForTest.newBuilder().setId(CONTENT_ID_2).build())
          .build();

  @Test
  public void clearAll() {
    ClearableStore store =
        (ClearableStore) getStore(ClockBackedFakeMainThreadRunner.runTasksImmediately());

    /*
    SETUP
    */

    // Payload
    CommitResult commitResult =
        store
            .editContent()
            .add(CONTENT_ID, STREAM_PAYLOAD)
            .add(CONTENT_ID_2, STREAM_PAYLOAD_2)
            .commit();
    assertThat(commitResult).isEqualTo(CommitResult.SUCCESS);

    Result<List<PayloadWithId>> payloadsResult =
        store.getPayloads(Arrays.asList(CONTENT_ID, CONTENT_ID_2));
    assertThat(payloadsResult.isSuccessful()).isTrue();
    assertThat(payloadsResult.getValue()).hasSize(2);

    // Action properties
    commitResult =
        store
            .editActionProperties()
            .add(CONTENT_ID, ACTION_PROPERTIES)
            .add(CONTENT_ID_2, ACTION_PROPERTIES_2)
            .commit();
    assertThat(commitResult).isEqualTo(CommitResult.SUCCESS);

    Result<List<ActionPropertiesWithId>> actionPropertiesResult =
        store.getActionProperties(Arrays.asList(CONTENT_ID, CONTENT_ID_2));
    assertThat(actionPropertiesResult.isSuccessful()).isTrue();
    assertThat(actionPropertiesResult.getValue()).hasSize(2);

    // Semantic properties
    commitResult =
        store
            .editSemanticProperties()
            .add(CONTENT_ID, ByteString.copyFrom(SEMANTIC_PROPERTIES))
            .add(CONTENT_ID_2, ByteString.copyFrom(SEMANTIC_PROPERTIES_2))
            .commit();
    assertThat(commitResult).isEqualTo(CommitResult.SUCCESS);

    Result<List<SemanticPropertiesWithId>> semanticPropertiesResult =
        store.getSemanticProperties(Arrays.asList(CONTENT_ID, CONTENT_ID_2));
    assertThat(semanticPropertiesResult.isSuccessful()).isTrue();
    assertThat(semanticPropertiesResult.getValue()).hasSize(2);

    // Shared State
    commitResult =
        store
            .editContent()
            .add(CONTENT_ID, STREAM_PAYLOAD_SHARED_STATE)
            .add(CONTENT_ID_2, STREAM_PAYLOAD_SHARED_STATE_2)
            .commit();
    assertThat(commitResult).isEqualTo(CommitResult.SUCCESS);

    Result<List<StreamSharedState>> sharedStatesResult = store.getSharedStates();
    assertThat(sharedStatesResult.isSuccessful()).isTrue();
    assertThat(sharedStatesResult.getValue()).hasSize(2);

    // Journal
    boolean boolCommitResult =
        store
            .editSession(SESSION_ID)
            .add(StreamStructure.newBuilder().setContentId(CONTENT_ID).build())
            .commit();
    assertThat(boolCommitResult).isTrue();
    boolCommitResult =
        store
            .editSession(SESSION_ID_2)
            .add(StreamStructure.newBuilder().setContentId(CONTENT_ID_2).build())
            .commit();
    assertThat(boolCommitResult).isTrue();

    Result<List<String>> sessionsResult = store.getAllSessions();
    assertThat(sessionsResult.isSuccessful()).isTrue();
    assertThat(sessionsResult.getValue()).hasSize(2);

    // Actions
    commitResult =
        store
            .editLocalActions()
            .add(ActionType.DISMISS, CONTENT_ID)
            .add(ActionType.DISMISS, CONTENT_ID_2)
            .commit();
    assertThat(commitResult).isEqualTo(CommitResult.SUCCESS);

    Result<List<StreamLocalAction>> dismissActionsResult = store.getAllDismissLocalActions();
    assertThat(dismissActionsResult.isSuccessful()).isTrue();
    assertThat(dismissActionsResult.getValue()).hasSize(2);

    /*
    CLEAR
    */

    assertThat(store.clearAll()).isTrue();

    /*
    VERIFICATION
    */

    // Payload
    payloadsResult = store.getPayloads(Collections.singletonList(CONTENT_ID));
    assertThat(payloadsResult.isSuccessful()).isTrue();
    assertThat(payloadsResult.getValue()).hasSize(0);

    // Semantic properties (should not be cleared)
    semanticPropertiesResult = store.getSemanticProperties(Arrays.asList(CONTENT_ID, CONTENT_ID_2));
    assertThat(semanticPropertiesResult.isSuccessful()).isTrue();
    assertThat(semanticPropertiesResult.getValue()).hasSize(0);

    // Action properties (should not be cleared)
    actionPropertiesResult = store.getActionProperties(Arrays.asList(CONTENT_ID, CONTENT_ID_2));
    assertThat(actionPropertiesResult.isSuccessful()).isTrue();
    assertThat(actionPropertiesResult.getValue()).isEmpty();

    // Shared state
    sharedStatesResult = store.getSharedStates();
    assertThat(sharedStatesResult.isSuccessful()).isTrue();
    assertThat(sharedStatesResult.getValue()).hasSize(0);

    // Journal
    sessionsResult = store.getAllSessions();
    assertThat(sessionsResult.isSuccessful()).isTrue();
    assertThat(sessionsResult.getValue()).hasSize(0);

    // Actions (should not be cleared)
    dismissActionsResult = store.getAllDismissLocalActions();
    assertThat(dismissActionsResult.isSuccessful()).isTrue();
    assertThat(dismissActionsResult.getValue()).hasSize(0);
  }
}