com.netflix.spinnaker.orca.q.messages.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of orca-queue Show documentation
Spinnaker Orca
There is a newer version: 8.59.0
/*
 * Copyright 2017 Netflix, Inc.
 *
 * 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.netflix.spinnaker.orca.q

import com.fasterxml.jackson.annotation.JsonTypeName
import com.netflix.spinnaker.orca.api.pipeline.SyntheticStageOwner
import com.netflix.spinnaker.orca.api.pipeline.SyntheticStageOwner.STAGE_BEFORE
import com.netflix.spinnaker.orca.api.pipeline.Task
import com.netflix.spinnaker.orca.api.pipeline.models.ExecutionStatus
import com.netflix.spinnaker.orca.api.pipeline.models.ExecutionType
import com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution
import com.netflix.spinnaker.orca.api.pipeline.models.StageExecution
import com.netflix.spinnaker.orca.api.pipeline.models.TaskExecution
import com.netflix.spinnaker.orca.pipeline.persistence.ExecutionRepository
import com.netflix.spinnaker.q.Attribute
import com.netflix.spinnaker.q.Message
import java.time.Duration

/**
 * Messages used internally by the queueing system.
 */
interface ApplicationAware {
  val application: String
}

interface ExecutionLevel : ApplicationAware {
  val executionType: ExecutionType
  val executionId: String
}

interface StageLevel : ExecutionLevel {
  val stageId: String
}

interface TaskLevel : StageLevel {
  val taskId: String
}

@JsonTypeName("startTask")
data class StartTask(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String
) : Message(), TaskLevel {
  constructor(source: ExecutionLevel, stageId: String, taskId: String) :
    this(source.executionType, source.executionId, source.application, stageId, taskId)

  constructor(source: StageLevel, taskId: String) :
    this(source, source.stageId, taskId)

  constructor(source: StageExecution, taskId: String) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id, taskId)

  constructor(source: StageExecution, task: TaskExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id, task.id)
}

@JsonTypeName("completeTask")
data class CompleteTask(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String,
  val status: ExecutionStatus,
  val originalStatus: ExecutionStatus?
) : Message(), TaskLevel {
  constructor(source: TaskLevel, status: ExecutionStatus) :
    this(source, status, status)

  constructor(source: TaskLevel, status: ExecutionStatus, originalStatus: ExecutionStatus) :
    this(
      source.executionType,
      source.executionId,
      source.application,
      source.stageId,
      source.taskId,
      status,
      originalStatus
    )
}

@JsonTypeName("pauseTask")
data class PauseTask(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String
) : Message(), TaskLevel {
  constructor(message: TaskLevel) :
    this(message.executionType, message.executionId, message.application, message.stageId, message.taskId)
}

@JsonTypeName("resumeTask")
data class ResumeTask(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String
) : Message(), TaskLevel {
  constructor(message: StageLevel, taskId: String) :
    this(message.executionType, message.executionId, message.application, message.stageId, taskId)
}

@JsonTypeName("runTask")
data class RunTask(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String,
  val taskType: Class
) : Message(), TaskLevel {
  override val ackTimeoutMs = Duration.ofMinutes(10).toMillis()

  constructor(message: StageLevel, taskId: String, taskType: Class) :
    this(message.executionType, message.executionId, message.application, message.stageId, taskId, taskType)

  constructor(message: TaskLevel, taskType: Class) :
    this(message.executionType, message.executionId, message.application, message.stageId, message.taskId, taskType)

  constructor(source: ExecutionLevel, stageId: String, taskId: String, taskType: Class) :
    this(source.executionType, source.executionId, source.application, stageId, taskId, taskType)
}

@JsonTypeName("startStage")
data class StartStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: ExecutionLevel, stageId: String) :
    this(source.executionType, source.executionId, source.application, stageId)

  constructor(source: StageLevel) :
    this(source, source.stageId)

  constructor(source: StageExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id)
}

@JsonTypeName("continueParentStage")
data class ContinueParentStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  /**
   * The phase that just completed, either before or after stages.
   */
  val phase: SyntheticStageOwner = STAGE_BEFORE
) : Message(), StageLevel {
  constructor(source: StageLevel, phase: SyntheticStageOwner) :
    this(source.executionType, source.executionId, source.application, source.stageId, phase)

  constructor(source: StageExecution, phase: SyntheticStageOwner) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id, phase)
}

@JsonTypeName("completeStage")
data class CompleteStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: ExecutionLevel, stageId: String) :
    this(source.executionType, source.executionId, source.application, stageId)

  constructor(source: StageLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId)

  constructor(source: StageExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id)
}

@JsonTypeName("skipStage")
data class SkipStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: StageLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId)

  constructor(source: StageExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id)
}

@JsonTypeName("abortStage")
data class AbortStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: StageLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId)

  constructor(source: StageExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id)
}

@JsonTypeName("pauseStage")
data class PauseStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: StageLevel) :
    this(source, source.stageId)

  constructor(source: ExecutionLevel, stageId: String) :
    this(source.executionType, source.executionId, source.application, stageId)
}

@JsonTypeName("restartStage")
data class RestartStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  val user: String?
) : Message(), StageLevel {
  constructor(source: PipelineExecution, stageId: String, user: String?) :
    this(source.type, source.id, source.application, stageId, user)

  constructor(stage: StageExecution, user: String?) :
    this(stage.execution.type, stage.execution.id, stage.execution.application, stage.id, user)
}

@JsonTypeName("resumeStage")
data class ResumeStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: ExecutionLevel, stageId: String) :
    this(source.executionType, source.executionId, source.application, stageId)

  constructor(source: StageExecution) :
    this(source.execution.type, source.execution.id, source.execution.application, source.id)
}

@JsonTypeName("cancelStage")
data class CancelStage(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : Message(), StageLevel {
  constructor(source: StageLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId)

  constructor(stage: StageExecution) :
    this(stage.execution.type, stage.execution.id, stage.execution.application, stage.id)
}

@JsonTypeName("startExecution")
data class StartExecution(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String
) : Message(), ExecutionLevel {
  constructor(source: PipelineExecution) :
    this(source.type, source.id, source.application)
}

@JsonTypeName("rescheduleExecution")
data class RescheduleExecution(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String
) : Message(), ExecutionLevel {
  constructor(source: PipelineExecution) :
    this(source.type, source.id, source.application)
}

@JsonTypeName("completeExecution")
data class CompleteExecution(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String
) : Message(), ExecutionLevel {
  constructor(source: ExecutionLevel) :
    this(source.executionType, source.executionId, source.application)

  constructor(source: PipelineExecution) :
    this(source.type, source.id, source.application)
}

@JsonTypeName("resumeExecution")
data class ResumeExecution(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String
) : Message(), ExecutionLevel {
  constructor(source: PipelineExecution) :
    this(source.type, source.id, source.application)
}

@JsonTypeName("cancelExecution")
data class CancelExecution(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  val user: String?,
  val reason: String?
) : Message(), ExecutionLevel {
  constructor(source: PipelineExecution, user: String?, reason: String?) :
    this(source.type, source.id, source.application, user, reason)

  constructor(source: PipelineExecution) :
    this(source.type, source.id, source.application, null, null)

  constructor(source: ExecutionLevel) :
    this(source.executionType, source.executionId, source.application, null, null)

  constructor(source: ExecutionLevel, user: String?, reason: String?) :
    this(source.executionType, source.executionId, source.application, user, reason)
}

@JsonTypeName("startWaitingExecutions")
data class StartWaitingExecutions(
  val pipelineConfigId: String,
  val purgeQueue: Boolean = false
) : Message()

/**
 * Fatal errors in processing the execution configuration.
 */
sealed class ConfigurationError : Message(), ExecutionLevel

/**
 * Execution id was not found in the [ExecutionRepository].
 */
@JsonTypeName("invalidExecutionId")
data class InvalidExecutionId(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String
) : ConfigurationError() {
  constructor(source: ExecutionLevel) :
    this(source.executionType, source.executionId, source.application)
}

/**
 * Stage id was not found in the execution.
 */
@JsonTypeName("invalidStageId")
data class InvalidStageId(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String
) : ConfigurationError(), StageLevel {
  constructor(source: StageLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId)
}

/**
 * Task id was not found in the stage.
 */
@JsonTypeName("invalidTaskId")
data class InvalidTaskId(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String
) : ConfigurationError(), TaskLevel {
  constructor(source: TaskLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId, source.taskId)
}

/**
 * No such [Task] class.
 */
@JsonTypeName("invalidTaskType")
data class InvalidTaskType(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  val className: String
) : ConfigurationError(), StageLevel {
  constructor(source: StageLevel, className: String) :
    this(source.executionType, source.executionId, source.application, source.stageId, className)
}

@JsonTypeName("noDownstreamTasks")
data class NoDownstreamTasks(
  override val executionType: ExecutionType,
  override val executionId: String,
  override val application: String,
  override val stageId: String,
  override val taskId: String
) : ConfigurationError(), TaskLevel {
  constructor(source: TaskLevel) :
    this(source.executionType, source.executionId, source.application, source.stageId, source.taskId)
}

@Deprecated("Kept only to support old messages on the queue without having to do a migration")
@JsonTypeName("totalThrottleTime")
data class TotalThrottleTimeAttribute(var totalThrottleTimeMs: Long = 0) : Attribute {
  fun add(throttleTimeMs: Long) {
    this.totalThrottleTimeMs += throttleTimeMs
  }
}