Uploaded image for project: 'OpenShift Cloud'
  1. OpenShift Cloud
  2. OCPCLOUD-1717

Add annotations to exceptions in providers package

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • None
    • None
    • CLOUD Sprint 241

      Background

      As described in the epic OCPCLOUD-1707, the exception statements `Except`, `Eventually`, and `Consistently` should have annotations associated with them so that debugging test failures is easier.

      As of the writing of this card the providers package of cluster-api-actuator-pkg contains the following references:

      $ ack Expect
      aws.go
      24:     Expect(err).ToNot(HaveOccurred())
      27:     Expect(err).ToNot(HaveOccurred())
      33:             Expect(err).ToNot(HaveOccurred())
      40:             Expect(framework.DeleteMachineSets(client, toDelete...)).To(Succeed())
      49:             Expect(err).ToNot(HaveOccurred())
      54:             Expect(err).ToNot(HaveOccurred())
      68:                     Expect(err).ToNot(HaveOccurred())
      81:                     Expect(err).ToNot(HaveOccurred())
      99:                     Expect(err).ToNot(HaveOccurred())
      100:                    Expect(logs).Should(ContainSubstring(responseSubstring))
      106:            Expect(err).To(HaveOccurred())
      107:            Expect(err.Error()).Should(ContainSubstring("Invalid value: \"fooobaar\": Allowed values are either 'Optional' or 'Required'"))
      112:            Expect(err).ToNot(HaveOccurred())
      118:            Expect(err).ToNot(HaveOccurred())
      
      $ ack Eventually
      aws.go
      85:                     Eventually(func() (bool, error) { 

      source

      Steps

      • Add annotations to exception statements

      Stakeholders

      • openshift engineering

      Definition of Done

      • Exceptions in the providers package have thoughtful annotations that point to root causes of failures
      • Docs
      • n/a
      • Testing
      • n/a

              raryan@redhat.com Rachel Ryan
              mimccune@redhat.com Michael McCune
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: