From 0b28dc21bc9347c86c0c72217b9e099970b1d90d Mon Sep 17 00:00:00 2001 From: Aman Kumar Gupta Date: Wed, 10 Oct 2018 21:35:28 +0530 Subject: [PATCH] Updated comments in README.md Signed-off-by: Aman Kumar Gupta --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2fea9f9..1d9a6fd 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ func TestIntegrationExample(t *testing.T) { var err error // Initializing CITF without config file. - // Also We should not include K8S as currently we don't have kubernetes environment setup + // Also we should not include K8S, as currently we don't have kubernetes environment setup. CitfInstance, err = citf.NewCITF(citfoptions.CreateOptionsIncludeAllButK8s("")) Expect(err).NotTo(HaveOccurred()) @@ -125,28 +125,28 @@ func TestIntegrationExample(t *testing.T) { var _ = BeforeSuite(func() { - // Setting up the default Platform i.e minikube + // Setting up the default platform i.e minikube. err := CitfInstance.Environment.Setup() Expect(err).NotTo(HaveOccurred()) - // You have to update the K8s config when environment has been set up - // this extra step will be unsolicited in upcoming changes. + // You have to update the K8s config when environment has been set up. + // This extra step will be unsolicited in upcoming changes. err = CitfInstance.Reload(citfoptions.CreateOptionsIncludeAll("")) Expect(err).NotTo(HaveOccurred()) - // Wait until platform is up + // Wait until platform is up. time.Sleep(30 * time.Second) err = CitfInstance.K8S.YAMLApply("./nginx-rc.yaml") Expect(err).NotTo(HaveOccurred()) - // Wait until the pod is up and running + // Wait until the pod is up and running. time.Sleep(30 * time.Second) }) var _ = AfterSuite(func() { - // Tear Down the Platform + // Tear Down the Platform. err := CitfInstance.Environment.Teardown() Expect(err).NotTo(HaveOccurred()) }) @@ -157,10 +157,10 @@ var _ = Describe("Integration Test", func() { pods, err := CitfInstance.K8S.GetPods("default", "nginx") Expect(err).NotTo(HaveOccurred()) - // Give pods some time to generate logs + // Give pods some time to generate logs. time.Sleep(2 * time.Second) - // Assuming that only 1 nginx pod is running + // Assuming that only 1 nginx pod is running. for _, v := range pods { log, err := CitfInstance.K8S.GetLog(v.GetName(), "default") Expect(err).NotTo(HaveOccurred())