Merge pull request #18 from oumkale/pod_delete

chore(experiment) : Pod-Delete Experiment and supporting Directory files added to litmus-python | BYOC added

Author: Shubham Chaudhary

.gitignore

@@ -1,7 +1,6 @@
 **/.idea
 **/*.egg-info
 **/.DS_Store
-**/build
 **/*intuit*/**
 **/*intuit.md
 **/*intuit*

.travis.yml

@@ -1,28 +1,47 @@
-dist: trusty
-sudo: required
+os: linux
+dist: bionic
+services:
+  - docker
 install: true
 stages:
   - shell check
   - build docker images
-env:
-  global:
-    - GOARCH=amd64
-before_install:
-  - sleep 15
-  - sudo apt-get install -y curl shellcheck
+  - push docker images
 
+before_script:
+  - sudo apt-get install -y curl shellcheck
+  - docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64
+  # #Upgrade to Docker CE 19.03 for BuildKit support
+  - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+  - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+  - sudo apt-get update
+  - sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce=5:19.03.8~3-0~ubuntu-bionic # pin version for reproducibility
+  # Show info to simplify debugging and create a builder
+  - docker info
+  - docker buildx create --name builder --use
+  - docker buildx ls
 jobs:
   include:
 
     - stage: shell check
       name: checking syntax of shell script
       script:
       - bash -c 'shopt -s globstar nullglob; shellcheck **/*.{sh,ksh,bash}' || true
+    
+    - stage: build docker images
+      name: installing and configuring dependencies
+      script:
+      - make deps
+    
+    - stage: build docker images
+      name: build docker image
+      script:
+      - make build
 
-    - stage: build chaos-test images
-      name: build docker image chaos-test
+    - stage: push docker images
+      name: push docker images
       script:
-      - make chaostest
+      - make push
 
 notifications:
   email:

Dockerfile

@@ -0,0 +1,53 @@
+
+FROM python:3.8
+
+LABEL maintainer="LitmusChaos"
+
+ARG TARGETARCH
+
+# upgrade and setup python
+RUN apt-get update \
+    && apt-get -y install gcc python-pip python3-pip python-dev curl \
+    && pip install --upgrade pip \
+    && pip install jinja2 pyYaml
+
+#Installing kops
+ENV kopsversion=v1.20.0
+RUN curl -Lsf -o kops-linux https://github.com/kubernetes/kops/releases/download/${kopsversion}/kops-linux-${TARGETARCH}
+RUN chmod +x ./kops-linux
+RUN mv ./kops-linux /usr/local/bin/kops
+
+#Installing Kubectl
+ENV KUBE_LATEST_VERSION="v1.18.0"
+RUN curl -L https://storage.googleapis.com/kubernetes-release/release/${KUBE_LATEST_VERSION}/bin/linux/${TARGETARCH}/kubectl -o     /usr/local/bin/kubectl && \
+chmod +x /usr/local/bin/kubectl
+
+RUN rm -rf /tmp/* /root/.cache
+
+ENV LC_ALL=C.UTF-8
+
+ENV LANG=C.UTF-8
+
+WORKDIR /litmus
+
+# Copying Necessary Files
+COPY . .
+
+# Setup requirements
+RUN pip3 install -r requirements.txt
+RUN python3 setup.py install
+
+WORKDIR /litmus/byoc
+
+# Setup requirements for byoc
+RUN chmod +x install.sh
+RUN ./install.sh
+
+WORKDIR /litmus
+
+# Copying experiment file
+COPY ./bin/experiment/experiment.py ./experiments
+
+ENV PYTHONPATH /litmus
+
+ENTRYPOINT ["python3"]

Makefile

@@ -1,17 +1,34 @@
-# Makefile for building Containers for Storage Testing
+
+# Makefile for building Litmus and its tools
 # Reference Guide - https://www.gnu.org/software/make/manual/make.html
 
 # Internal variables or constants.
 # NOTE - These will be executed when any make target is invoked.
-IS_DOCKER_INSTALLED       := $(shell which docker >> /dev/null 2>&1; echo $$?)
 
+IS_DOCKER_INSTALLED = $(shell which docker >> /dev/null 2>&1; echo $$?)
+
+# Docker info
+DOCKER_REPO ?= litmuschaos
+DOCKER_IMAGE ?= py-runner
+DOCKER_TAG ?= ci
+
+.PHONY: help
 help:
 	@echo ""
 	@echo "Usage:-"
-	@echo "\tmake deps              -- will verify build dependencies are installed"
-	@echo "\tmake chaostest      -- will build and push python experiment images
+	@echo "\tmake deps				-- sets up dependencies for image build"
+	@echo "\tmake build				-- builds the litmus-py multi-arch image"
+	@echo "\tmake push				-- pushes the litmus-py multi-arch image"
+	@echo "\tmake build-amd64			-- builds the litmus-py docker amd64 image"
+	@echo "\tmake push-amd64			-- pushes the litmus-py amd64 image"
 	@echo ""
 
+.PHONY: all
+all: deps build push
+
+.PHONY: deps
+deps: _build_check_docker
+
 _build_check_docker:
 	@if [ $(IS_DOCKER_INSTALLED) -eq 1 ]; \
 		then echo "" \
@@ -20,16 +37,47 @@ _build_check_docker:
 		&& exit 1; \
 		fi;
 
-deps: _build_check_docker
-	@echo ""
-	@echo "INFO:\tverifying dependencies for litmus-python ..."
+.PHONY: build
+build: docker.buildx image-build
+
+.PHONY: docker.buildx
+docker.buildx:
+	@echo "------------------------------"
+	@echo "--> Setting up Builder        " 
+	@echo "------------------------------"
+	@if ! docker buildx ls | grep -q multibuilder; then\
+		docker buildx create --name multibuilder;\
+		docker buildx inspect multibuilder --bootstrap;\
+		docker buildx use multibuilder;\
+	fi
+
+.PHONY: image-build
+image-build:	
+	@echo "-------------------------"
+	@echo "--> Build py-runner image" 
+	@echo "-------------------------"
+	@docker buildx build --file Dockerfile --progress plane --platform linux/arm64,linux/amd64 --no-cache --tag $(DOCKER_REPO)/$(DOCKER_IMAGE):$(DOCKER_TAG) .
+
+.PHONY: push
+push: docker.buildx litmus-py-push
 
-_build_tests_chaostest_image:
-	@echo "INFO: Building container image for performing chaostoolkit tests"
-	cd chaos-test && docker build -t litmuschaos/chaostoolkit:ci .
+.PHONE: litmus-py-push
+litmus-py-push:
+	@echo "-------------------"
+	@echo "--> py-runner image" 
+	@echo "-------------------"
+	REGISTRYNAME="$(DOCKER_REGISTRY)" REPONAME="$(DOCKER_REPO)" IMGNAME="$(DOCKER_IMAGE)" IMGTAG="$(DOCKER_TAG)" ./build/push
 
-_push_tests_chaostest_image:
-	@echo "INFO: Publish container litmuschaos/chaostoolkit:ci"
-	REPONAME="litmuschaos" IMGNAME="chaostoolkit" IMGTAG="ci" ./chaos-test/buildscripts/push
+.PHONY: build-amd64 
+build-amd64:
+	@echo "-------------------------"
+	@echo "--> Build py-runner amd64 image" 
+	@echo "-------------------------"
+	@sudo docker build --file Dockerfile --tag $(DOCKER_REPO)/$(DOCKER_IMAGE):$(DOCKER_TAG) . --build-arg TARGETARCH=amd64
 
-chaostest: deps _build_tests_chaostest_image _push_tests_chaostest_image
+.PHONY: push-amd64
+push-amd64:
+	@echo "-------------------"
+	@echo "--> push py-runner image" 
+	@echo "-------------------"
+	REPONAME="$(DOCKER_REPO)" IMGNAME="$(DOCKER_IMAGE)" IMGTAG="$(DOCKER_TAG)" ./build/push

README.md

@@ -1,42 +1,13 @@
 ### litmus-python:
 
-This repo consists of Litmus Chaos Experiments written in Python. The examples in this repo are good indicators
-of how to construct the various experiment pieces in python: complete with steady state checks, chaos injection,
-chaosresult generation, post chaos checks, events generation, reports for observability etc..,
-
-The chaos injection mechanism employed itself may vary ranging right from non-standard/custom approaches to reuse of
-popular tools like chaostoolkit.
+- This repo consists of Litmus Chaos Experiments written in python. The examples in this repo are good indicators
+of how to construct the experiments in python: complete with steady state checks, chaosresult generation, chaos injection,
+post chaos checks, create events and reports for observability and configure sinks for these.
 
 **NOTE**
 
 - This repo can be viewed as an extension to the [litmuschaos/litmus](https://github.com/litmuschaos/litmus) repo
-  in the sense that the litmus repo also houses a set of chaos experiments, built using ansible. The litmus repo
-  will also continue to be the project's community-facing meta repo housing other important project arefacts.
-  The litmus-python is very similar to and therefore a sister repo of [litmus-go](https://github.com/litmuschaos/litmus-go)
-  which houses examples for experiment business logic written in golang.
-
-### commit process
-- Fork the project
-    * checkout the project using 
-    ```
-    git clone [email protected]:sumitnagal/litmus-python.git
-    ```
-    * go to your folder 
-    ```
-    cd litmus-python
-    ```
-    * add upstream for main and intuit repo
-    ```
-    git remote add upstream [email protected]:litmuschaos/litmus-python.git
-    git pull upstream master
-    git checkout -b <branch name>
-    ```
-    * Make the changes and commit with signed
-    ```
-    git add .
-    git commit -s -m "<message>"
-    git push origin <branch>
-    ```
-
-### Appendix
-- This repo moved from existing location of [test-tools/chaostoolkit](https://github.com/litmuschaos/test-tools/tree/master/chaostoolkit) to better serve as stand-alone project
+  in the sense that the litmus repo also houses a significant set of experiments, built using ansible. The litmus repo
+  will also continue to be the project's community-facing meta repo housing other important project artifacts. In that
+  sense, litmus-py is very similar to and therefore a sister repo of [litmus-go](https://github.com/litmuschaos/litmus-go) which
+  houses examples for experiment business logic written in python.

chaos-test/__init__.py renamed to __init__.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+import experimentList.generic.podDelete.podDelete as podDelete
+import argparse
+import logging
+import pkg.utils.client.client as client
+
+logging.basicConfig(format='time=%(asctime)s level=%(levelname)s  msg=%(message)s', level=logging.INFO)  
+
+def main():
+	parser = argparse.ArgumentParser()
+	
+	# parse the experiment name
+	parser.add_argument("-name", action='store', default="pod-delete", dest="name", help="Chaos experiment for execution")
+	# parse the kubeconfig
+	parser.add_argument("-kubeconfig", required=False, default="", dest='kubeconfig', help="Absolute path to the kubeconfig file")
+	args = parser.parse_args()
+	
+	#Getting kubeConfig and Generate ClientSets
+	config = client.Configuration(kubeconfig=args.kubeconfig)
+	clients = client.K8sClient(conf = config.get_config())
+	logging.info("Experiment Name: %s", args.name)
+
+	# invoke the corresponding experiment based on the the (-name) flag
+	if args.name == "pod-delete":
+		podDelete.PodDelete(clients)
+	else:
+		logging.error("Unsupported -name %s, please provide the correct value of -name args", args.name)
+	return
+if __name__ == "__main__":
+	main()
+