com.netflix.spinnaker.echo.config.QuietPeriodIndicatorConfigurationProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo-pipelinetriggers Show documentation
Spinnaker Echo
The newest version!
/*
 * Copyright 2018 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.echo.config;

import static java.time.format.DateTimeFormatter.ISO_INSTANT;

import com.google.common.base.Strings;
import com.netflix.spinnaker.kork.dynamicconfig.DynamicConfigService;
import java.time.Instant;
import java.time.format.DateTimeParseException;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Configuration properties for QuietPeriodIndicator
 *
 * CAVEAT: These properties are a bit weird in that they have only one setter (for
 * suppressedTriggerTypes) This is because all these properties are always queried from the
 * DynamicConfigService, which will use Spring properties as one of the sources so no setter is
 * needed. This is also why we include ignoreInvalidFields = true on the annotation below
 *
 * 
The expectation is that quiet period can be changed easily at runtime without re-deploying.
 *
 * 
Example of properties:
 *
 * 
 * quietPeriod:
 *  enabled: true
 *  startIso: 2020-02-09T21:00:00Z
 *  endIso: 2020-02-10T13:00:00Z
 *  suppressedTriggerTypes:
 *    - cron
 *    - docker
 *    - git
 *    - jenkins
 * 
 */
@ConfigurationProperties(prefix = "quiet-period", ignoreInvalidFields = true)
public class QuietPeriodIndicatorConfigurationProperties {

  private List suppressedTriggerTypes = new ArrayList<>();
  private DynamicConfigService dynamicConfigService;
  private Logger log = LoggerFactory.getLogger(this.getClass().getName());

  public QuietPeriodIndicatorConfigurationProperties(DynamicConfigService dynamicConfigService) {
    this.dynamicConfigService = dynamicConfigService;
  }

  public boolean isEnabled() {
    return (dynamicConfigService.isEnabled("quiet-period", true)
        && getStartTime() > 0
        && getEndTime() > 0);
  }

  public long getStartTime() {
    return parseIso(dynamicConfigService.getConfig(String.class, "quiet-period.start-iso", ""));
  }

  public long getEndTime() {
    return parseIso(dynamicConfigService.getConfig(String.class, "quiet-period.end-iso", ""));
  }

  public List getSuppressedTriggerTypes() {
    return suppressedTriggerTypes;
  }

  public void setSuppressedTriggerTypes(List suppressedTriggerTypes) {
    this.suppressedTriggerTypes = suppressedTriggerTypes;
  }

  private long parseIso(String iso) {
    if (Strings.isNullOrEmpty(iso)) {
      return -1;
    }
    try {
      Instant instant = Instant.from(ISO_INSTANT.parse(iso));
      return instant.toEpochMilli();
    } catch (DateTimeParseException e) {
      log.warn(
          "Unable to parse {} as an ISO date/time, disabling quiet periods: {}",
          iso,
          e.getMessage());
      return -1;
    }
  }
}