Merge pull request Netflix#236 from atlassian/ASGTagFiltering

Apply the ASG Tag filtering on ASGCrawler

Author: lorin

src/main/java/com/netflix/simianarmy/basic/BasicChaosMonkeyContext.java

@@ -28,6 +28,8 @@
 import com.netflix.simianarmy.chaos.ChaosInstanceSelector;
 import com.netflix.simianarmy.chaos.ChaosMonkey;
 import com.netflix.simianarmy.client.aws.chaos.ASGChaosCrawler;
+import com.netflix.simianarmy.client.aws.chaos.FilteringChaosCrawler;
+import com.netflix.simianarmy.client.aws.chaos.TagPredicate;
 
 /**
  * The Class BasicContext. This provide the basic context needed for the Chaos Monkey to run. It will configure
@@ -50,9 +52,13 @@ public class BasicChaosMonkeyContext extends BasicSimianArmyContext implements C
      */
     public BasicChaosMonkeyContext() {
         super("simianarmy.properties", "client.properties", "chaos.properties");
-        setChaosCrawler(new ASGChaosCrawler(awsClient()));
-        setChaosInstanceSelector(new BasicChaosInstanceSelector());
         MonkeyConfiguration cfg = configuration();
+        String tagKey = cfg.getStrOrElse("simianarmy.chaos.ASGtag.key", "");
+        String tagValue = cfg.getStrOrElse("simianarmy.chaos.ASGtag.value", "");
+
+        ASGChaosCrawler chaosCrawler = new ASGChaosCrawler(awsClient());
+        setChaosCrawler(tagKey.isEmpty() ? chaosCrawler : new FilteringChaosCrawler(chaosCrawler, new TagPredicate(tagKey, tagValue)));
+        setChaosInstanceSelector(new BasicChaosInstanceSelector());
         AmazonSimpleEmailServiceClient sesClient = new AmazonSimpleEmailServiceClient(awsClientConfig);
         if (configuration().getStr("simianarmy.aws.email.region") != null) {
            sesClient.setRegion(Region.getRegion(Regions.fromName(configuration().getStr("simianarmy.aws.email.region"))));

src/main/java/com/netflix/simianarmy/basic/chaos/BasicInstanceGroup.java

@@ -21,6 +21,7 @@
 import java.util.LinkedList;
 import java.util.List;
 
+import com.amazonaws.services.autoscaling.model.TagDescription;
 import com.netflix.simianarmy.GroupType;
 import com.netflix.simianarmy.chaos.ChaosCrawler.InstanceGroup;
 
@@ -38,20 +39,28 @@ public class BasicInstanceGroup implements InstanceGroup {
     /** The region. */
     private final String region;
 
+    /** list of the tags of the ASG */
+    private final List<TagDescription> tags;
+
     /**
      * Instantiates a new basic instance group.
      *
      * @param name
      *            the name
      * @param type
      *            the type
+     * @param tags
+     *            the ASG tags
      */
-    public BasicInstanceGroup(String name, GroupType type, String region) {
+    public BasicInstanceGroup(String name, GroupType type, String region, List<TagDescription> tags) {
         this.name = name;
         this.type = type;
         this.region = region;
+        this.tags = tags;
     }
 
+
+
     /** {@inheritDoc} */
     public GroupType type() {
         return type;
@@ -67,6 +76,11 @@ public String region() {
         return region;
     }
 
+    /** {@inheritDoc} */
+    public List<TagDescription> tags() {
+        return tags;
+    }
+
     /** The list. */
     private List<String> list = new LinkedList<String>();
 
@@ -85,7 +99,7 @@ public void addInstance(String instance) {
     /** {@inheritDoc} */
     @Override
     public BasicInstanceGroup copyAs(String newName) {
-        BasicInstanceGroup newGroup = new BasicInstanceGroup(newName, this.type(), this.region());
+        BasicInstanceGroup newGroup = new BasicInstanceGroup(newName, this.type(), this.region(), this.tags());
         for (String instance: this.instances()) {
             newGroup.addInstance(instance);
         }

src/main/java/com/netflix/simianarmy/chaos/ChaosCrawler.java

@@ -20,6 +20,7 @@
 import java.util.EnumSet;
 import java.util.List;
 
+import com.amazonaws.services.autoscaling.model.TagDescription;
 import com.netflix.simianarmy.GroupType;
 
 /**
@@ -53,6 +54,13 @@ public interface InstanceGroup {
          */
         String region();
 
+        /**
+         * Tags.
+         *
+         * @return the list of tags associated with group type
+         */
+        List<TagDescription> tags();
+
         /**
          * Instances.
          *

src/main/java/com/netflix/simianarmy/client/aws/chaos/ASGChaosCrawler.java

@@ -108,9 +108,9 @@ protected InstanceGroup getInstanceGroup(AutoScalingGroup asg, double aggression
 
       // if coefficient is 1 then the BasicInstanceGroup is fine, otherwise use Tunable
       if (aggressionCoefficient == 1.0) {
-          instanceGroup = new BasicInstanceGroup(asg.getAutoScalingGroupName(), Types.ASG, awsClient.region());
+          instanceGroup = new BasicInstanceGroup(asg.getAutoScalingGroupName(), Types.ASG, awsClient.region(), asg.getTags());
       } else {
-        TunableInstanceGroup tunable = new TunableInstanceGroup(asg.getAutoScalingGroupName(), Types.ASG, awsClient.region());
+        TunableInstanceGroup tunable = new TunableInstanceGroup(asg.getAutoScalingGroupName(), Types.ASG, awsClient.region(), asg.getTags());
         tunable.setAggressionCoefficient(aggressionCoefficient);
 
         instanceGroup = tunable;

src/main/java/com/netflix/simianarmy/client/aws/chaos/FilteringChaosCrawler.java

@@ -0,0 +1,68 @@
+/*
+ *
+ *  Copyright 2012 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.simianarmy.client.aws.chaos;
+
+import com.google.common.base.Predicate;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Lists;
+import com.netflix.simianarmy.chaos.ChaosCrawler;
+
+import java.util.EnumSet;
+import java.util.List;
+
+/**
+ * The Class FilteringChaosCrawler. This will filter the result from ASGChaosCrawler for all available AutoScalingGroups associated with the AWS account based on requested filter.
+ */
+public class FilteringChaosCrawler implements ChaosCrawler {
+
+    private final ChaosCrawler crawler;
+    private final Predicate<? super InstanceGroup> predicate;
+
+    public FilteringChaosCrawler(ChaosCrawler crawler, Predicate<? super InstanceGroup> predicate) {
+        this.crawler = crawler;
+        this.predicate = predicate;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public EnumSet<?> groupTypes() {
+        return crawler.groupTypes();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public List<InstanceGroup> groups() {
+        return filter(crawler.groups());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public List<InstanceGroup> groups(String... names) {
+        return filter(crawler.groups(names));
+    }
+
+
+    /**
+     * Return the filtered list of InstanceGroups using the requested predicate. The filter is applied on the InstanceGroup retrieved from the ASGChaosCrawler class.
+     * @param list list of InstanceGroups result of the chaos crawler
+     * @return The appropriate {@link InstanceGroup}
+     */
+    protected List<InstanceGroup> filter(List<InstanceGroup> list) {
+        return Lists.newArrayList(Iterables.filter(list, predicate));
+    }
+}

src/main/java/com/netflix/simianarmy/client/aws/chaos/TagPredicate.java

@@ -0,0 +1,46 @@
+/*
+ *
+ *  Copyright 2012 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.simianarmy.client.aws.chaos;
+
+import com.amazonaws.services.autoscaling.model.TagDescription;
+import com.google.common.base.Predicate;
+import com.google.common.collect.Iterables;
+import com.netflix.simianarmy.chaos.ChaosCrawler;
+
+/**
+ *  * The Class TagPredicate. This will apply the tag-key and the tag-value filter on the list of InstanceGroups .
+ */
+public class TagPredicate implements Predicate<ChaosCrawler.InstanceGroup> {
+
+    private final String key, value;
+
+    public TagPredicate(String key, String value) {
+        this.key = key;
+        this.value = value;
+    }
+
+    @Override
+    public boolean apply(ChaosCrawler.InstanceGroup instanceGroup) {
+        return Iterables.any(instanceGroup.tags(), new com.google.common.base.Predicate<TagDescription>() {
+            @Override
+            public boolean apply(TagDescription tagDescription) {
+                return tagDescription.getKey().equals(key) && tagDescription.getValue().equals(value);
+            }
+        });
+    }
+}

src/main/java/com/netflix/simianarmy/tunable/TunableInstanceGroup.java

@@ -1,8 +1,11 @@
 package com.netflix.simianarmy.tunable;
 
+import com.amazonaws.services.autoscaling.model.TagDescription;
 import com.netflix.simianarmy.GroupType;
 import com.netflix.simianarmy.basic.chaos.BasicInstanceGroup;
 
+import java.util.List;
+
 /**
  * Allows for individual InstanceGroups to alter the aggressiveness
  * of ChaosMonkey.
@@ -12,8 +15,8 @@
  */
 public class TunableInstanceGroup extends BasicInstanceGroup {
 
-  public TunableInstanceGroup(String name, GroupType type, String region) {
-    super(name, type, region);
+  public TunableInstanceGroup(String name, GroupType type, String region, List<TagDescription> tags) {
+    super(name, type, region, tags);
   }
 
   private double aggressionCoefficient = 1.0;

src/main/resources/chaos.properties

@@ -98,3 +98,6 @@ simianarmy.chaos.mandatoryTermination.defaultProbability = 0.5
 
 # Enable the email subject to be the same as the body, to include terminated instance and group information
 #simianarmy.chaos.notification.subject.isBody = true
+#set the tag filter on the ASGs to terminate only instances from the ASG with the this tag key and value
+#simianarmy.chaos.ASGtag.key = chaos_monkey
+#simianarmy.chaos.ASGtag.value = true

src/test/java/com/netflix/simianarmy/basic/chaos/TestBasicChaosInstanceSelector.java

@@ -18,12 +18,9 @@
 // CHECKSTYLE IGNORE Javadoc
 package com.netflix.simianarmy.basic.chaos;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Arrays;
-import java.util.Map;
-import java.util.HashMap;
+import java.util.*;
 
+import com.amazonaws.services.autoscaling.model.TagDescription;
 import com.netflix.simianarmy.GroupType;
 import com.netflix.simianarmy.chaos.ChaosInstanceSelector;
 import com.netflix.simianarmy.chaos.ChaosCrawler.InstanceGroup;
@@ -61,6 +58,10 @@ public String region() {
             return "region";
         }
 
+        public List<TagDescription> tags() {
+            return Collections.<TagDescription>emptyList();
+        }
+
         public List<String> instances() {
             return Arrays.asList("i-123456789012345670", "i-123456789012345671", "i-123456789012345672", "i-123456789012345673", "i-123456789012345674",
                     "i-123456789012345675", "i-123456789012345676", "i-123456789012345677", "i-123456789012345678", "i-123456789012345679");

src/test/java/com/netflix/simianarmy/basic/chaos/TestBasicChaosMonkey.java

@@ -18,6 +18,8 @@
 // CHECKSTYLE IGNORE Javadoc
 package com.netflix.simianarmy.basic.chaos;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
@@ -33,6 +35,7 @@
 import com.netflix.simianarmy.chaos.ChaosMonkey;
 import com.netflix.simianarmy.chaos.TestChaosMonkeyContext;
 import com.netflix.simianarmy.resources.chaos.ChaosMonkeyResource;
+import com.amazonaws.services.autoscaling.model.TagDescription;
 
 // CHECKSTYLE IGNORE MagicNumberCheck
 public class TestBasicChaosMonkey {
@@ -360,17 +363,18 @@ public void testMaxTerminationCountPerDayGroupLevel() {
 
     @Test
     public void testGetValueFromCfgWithDefault() {
+
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("propertiesWithDefaults.properties");
         BasicChaosMonkey chaos = new BasicChaosMonkey(ctx);
 
         // named 1 has actual values in config
-        InstanceGroup named1 = new BasicInstanceGroup("named1", GroupTypes.TYPE_A, "test-dev-1");
+        InstanceGroup named1 = new BasicInstanceGroup("named1", GroupTypes.TYPE_A, "test-dev-1", Collections.<TagDescription>emptyList());
 
         // named 2 doesn't have values but it's group has values
-        InstanceGroup named2 = new BasicInstanceGroup("named2", GroupTypes.TYPE_A, "test-dev-1");
+        InstanceGroup named2 = new BasicInstanceGroup("named2", GroupTypes.TYPE_A, "test-dev-1", Collections.<TagDescription>emptyList());
 
         // named 3 doesn't have values and it's group doesn't have values
-        InstanceGroup named3 = new BasicInstanceGroup("named3", GroupTypes.TYPE_B, "test-dev-1");
+        InstanceGroup named3 = new BasicInstanceGroup("named3", GroupTypes.TYPE_B, "test-dev-1", Collections.<TagDescription>emptyList());
 
         Assert.assertEquals(chaos.getBoolFromCfgOrDefault(named1, "enabled", true), false);
         Assert.assertEquals(chaos.getNumFromCfgOrDefault(named1, "probability", 3.0), 1.1);

src/test/java/com/netflix/simianarmy/basic/chaos/TestCloudFormationChaosMonkey.java

@@ -18,6 +18,7 @@
 // CHECKSTYLE IGNORE Javadoc
 package com.netflix.simianarmy.basic.chaos;
 
+import com.amazonaws.services.autoscaling.model.TagDescription;
 import org.testng.Assert;
 import org.testng.annotations.Test;
 import static org.testng.Assert.assertEquals;
@@ -27,6 +28,8 @@
 import com.netflix.simianarmy.chaos.TestChaosMonkeyContext;
 import com.netflix.simianarmy.chaos.ChaosCrawler.InstanceGroup;
 
+import java.util.Collections;
+
 public class TestCloudFormationChaosMonkey {
 
     public static final long EXPECTED_MILLISECONDS = 2000;
@@ -36,9 +39,9 @@ public void testIsGroupEnabled() {
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("cloudformation.properties");
         CloudFormationChaosMonkey chaos = new CloudFormationChaosMonkey(ctx);
         InstanceGroup group1 = new BasicInstanceGroup("new-group-TestGroup1-XCFNFNFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         InstanceGroup group2 = new BasicInstanceGroup("new-group-TestGroup2-XCFNGHFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         assertTrue(chaos.isGroupEnabled(group1));
         assertFalse(chaos.isGroupEnabled(group2));
     }
@@ -48,7 +51,7 @@ public void testIsMaxTerminationCountExceeded() {
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("cloudformation.properties");
         CloudFormationChaosMonkey chaos = new CloudFormationChaosMonkey(ctx);
         InstanceGroup group1 = new BasicInstanceGroup("new-group-TestGroup1-XCFNFNFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         assertFalse(chaos.isMaxTerminationCountExceeded(group1));
     }
 
@@ -57,7 +60,7 @@ public void testGetEffectiveProbability() {
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("cloudformation.properties");
         CloudFormationChaosMonkey chaos = new CloudFormationChaosMonkey(ctx);
         InstanceGroup group1 = new BasicInstanceGroup("new-group-TestGroup1-XCFNFNFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         assertEquals(1.0, chaos.getEffectiveProbability(group1));
     }
 
@@ -66,7 +69,7 @@ public void testNoSuffixInstanceGroup() {
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("disabled.properties");
         CloudFormationChaosMonkey chaos = new CloudFormationChaosMonkey(ctx);
         InstanceGroup group = new BasicInstanceGroup("new-group-TestGroup-XCFNFNFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         InstanceGroup newGroup = chaos.noSuffixInstanceGroup(group);
         assertEquals(newGroup.name(), "new-group-TestGroup");
     }
@@ -76,7 +79,7 @@ public void testGetLastOptInMilliseconds() {
         TestChaosMonkeyContext ctx = new TestChaosMonkeyContext("cloudformation.properties");
         CloudFormationChaosMonkey chaos = new CloudFormationChaosMonkey(ctx);
         InstanceGroup group = new BasicInstanceGroup("new-group-TestGroup1-XCFNFNFNF",
-                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region");
+                TestChaosMonkeyContext.CrawlerTypes.TYPE_D, "region", Collections.<TagDescription>emptyList());
         assertEquals(chaos.getLastOptInMilliseconds(group), EXPECTED_MILLISECONDS);
     }