content: /**
   * 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 org.apache.aurora.scheduler.storage;
  
  import java.util.Optional;
  import java.util.Set;
  
  import com.google.common.collect.ImmutableSet;
  import com.google.inject.Guice;
  import com.google.inject.Injector;
  import com.google.inject.Module;
  
  import org.apache.aurora.gen.CronCollisionPolicy;
  import org.apache.aurora.gen.Identity;
  import org.apache.aurora.gen.JobConfiguration;
  import org.apache.aurora.gen.ScheduleStatus;
  import org.apache.aurora.scheduler.base.JobKeys;
  import org.apache.aurora.scheduler.base.TaskTestUtil;
  import org.apache.aurora.scheduler.base.Tasks;
  import org.apache.aurora.scheduler.storage.Storage.MutateWork.NoResult;
  import org.apache.aurora.scheduler.storage.entities.IJobConfiguration;
  import org.apache.aurora.scheduler.storage.entities.IJobKey;
  import org.apache.aurora.scheduler.storage.entities.IScheduledTask;
  import org.apache.aurora.scheduler.storage.entities.ITaskConfig;
  import org.apache.aurora.scheduler.storage.testing.StorageEntityUtil;
  import org.junit.Before;
  import org.junit.Test;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNull;
  
  public abstract class AbstractCronJobStoreTest {
    protected static final IJobConfiguration JOB_A = makeJob("a");
    protected static final IJobConfiguration JOB_B = makeJob("b");
  
    private static final IJobKey KEY_A = JOB_A.getKey();
    private static final IJobKey KEY_B = JOB_B.getKey();
  
    protected Injector injector;
    protected Storage storage;
  
    protected abstract Module getStorageModule();
  
    @Before
    public void setUp() {
      injector = Guice.createInjector(getStorageModule());
      storage = injector.getInstance(Storage.class);
      storage.prepare();
    }
  
    @Test
    public void testJobStore() {
      assertNull(fetchJob(JobKeys.from("nobody", "nowhere", "noname")).orElse(null));
      assertEquals(ImmutableSet.of(), fetchJobs());
  
      saveAcceptedJob(JOB_A);
      assertEquals(JOB_A, fetchJob(KEY_A).orElse(null));
      assertEquals(ImmutableSet.of(JOB_A), fetchJobs());
  
      saveAcceptedJob(JOB_B);
      assertEquals(JOB_B, fetchJob(KEY_B).orElse(null));
      assertEquals(ImmutableSet.of(JOB_A, JOB_B), fetchJobs());
  
      removeJob(KEY_B);
      assertEquals(ImmutableSet.of(JOB_A), fetchJobs());
  
      deleteJobs();
      assertEquals(ImmutableSet.of(), fetchJobs());
    }
  
    @Test
    public void testJobStoreSameEnvironment() {
      IJobConfiguration templateConfig = makeJob("labrat");
      JobConfiguration prodBuilder = templateConfig.newBuilder();
      prodBuilder.getKey().setEnvironment("prod");
      IJobConfiguration prod = IJobConfiguration.build(prodBuilder);
      JobConfiguration stagingBuilder = templateConfig.newBuilder();
      stagingBuilder.getKey().setEnvironment("staging");
      IJobConfiguration staging = IJobConfiguration.build(stagingBuilder);
  
      saveAcceptedJob(prod);
      saveAcceptedJob(staging);
  
      assertNull(fetchJob(
          IJobKey.build(templateConfig.getKey().newBuilder().setEnvironment("test"))).orElse(null));
      assertEquals(prod, fetchJob(prod.getKey()).orElse(null));
      assertEquals(staging, fetchJob(staging.getKey()).orElse(null));
  
      removeJob(prod.getKey());
      assertNull(fetchJob(prod.getKey()).orElse(null));
      assertEquals(staging, fetchJob(staging.getKey()).orElse(null));
    }
  
    @Test
    public void testTaskConfigDedupe() {
      // Test for regression of AURORA-1392.
  
      IScheduledTask instance = TaskTestUtil.makeTask("a", JOB_A.getTaskConfig());
      storage.write((NoResult.Quiet)
          storeProvider -> storeProvider.getUnsafeTaskStore().saveTasks(ImmutableSet.of(instance)));
  
      saveAcceptedJob(JOB_A);
  
      storage.write(storeProvider ->
          storeProvider.getUnsafeTaskStore().mutateTask(
              Tasks.id(instance),
              task -> IScheduledTask.build(task.newBuilder().setStatus(ScheduleStatus.RUNNING))));
    }
  
    @Test
    public void testUpdate() {
      // Test for regression of AURORA-1390.  Updates are not normal, but are used in cases such as
      // backfilling fields upon storage recovery.
  
      saveAcceptedJob(JOB_A);
      IJobConfiguration jobAUpdated =
          IJobConfiguration.build(JOB_A.newBuilder().setCronSchedule("changed"));
      saveAcceptedJob(jobAUpdated);
      assertEquals(jobAUpdated, fetchJob(KEY_A).orElse(null));
    }
  
    private static IJobConfiguration makeJob(String name) {
      IJobKey job = JobKeys.from("role-" + name, "env-" + name, name);
      ITaskConfig config = TaskTestUtil.makeConfig(job);
  
      return StorageEntityUtil.assertFullyPopulated(
          IJobConfiguration.build(
              new JobConfiguration()
                  .setKey(job.newBuilder())
                  .setOwner(new Identity().setUser("user"))
                  .setCronSchedule("schedule")
                  .setCronCollisionPolicy(CronCollisionPolicy.CANCEL_NEW)
                  .setTaskConfig(config.newBuilder())
                  .setInstanceCount(5)));
    }
  
    private Set<IJobConfiguration> fetchJobs() {
      return storage.read(
          storeProvider -> ImmutableSet.copyOf(storeProvider.getCronJobStore().fetchJobs()));
    }
  
    private Optional<IJobConfiguration> fetchJob(IJobKey jobKey) {
      return storage.read(storeProvider -> storeProvider.getCronJobStore().fetchJob(jobKey));
    }
  
    protected void saveAcceptedJob(IJobConfiguration jobConfig) {
      storage.write((NoResult.Quiet)
          storeProvider -> storeProvider.getCronJobStore().saveAcceptedJob(jobConfig));
    }
  
    private void removeJob(IJobKey jobKey) {
      storage.write(
          (NoResult.Quiet) storeProvider -> storeProvider.getCronJobStore().removeJob(jobKey));
    }
  
    protected void deleteJobs() {
      storage.write((NoResult.Quiet) storeProvider -> storeProvider.getCronJobStore().deleteJobs());
    }
  }
  