chore(source): code cleanup

[ivankatliarchuk]

Description

No changes to business logic. Slicing this pull request #5186.

Moved few methods to shared/utils folder, added code re-use in some services. Increased code coverage for moved functions.

Target is to support for istio support v1alpha3 and v1. draft pull request is here gofogo#10

Checklist

• Unit tests updated
• End user documentation updated

[ivankatliarchuk]

/kind cleanup
/label tide/merge-method-squash

[mloiseleur]

Would you please rename source/annotations/annottaions.go to source/annotations/annotations.go ?

[ivankatliarchuk]

@mloiseleur Done

[mloiseleur]

/lgtm

[ivankatliarchuk]

Cool. Let me know if needs further split. Most changes - licence and test coverage.

[szuecs]

In Go we use "ok" as var name in these cases, please change all of them.
exists -> ok

[ivankatliarchuk]

done

[szuecs]

Just FYI, so does not need to be changed: you can also omit the "tests" var and start with the for loop and have an inline struct definition. I think it looks like this (out of my head without parser or compiler):

for _, tt := range []struct{
   name string
   ...
  }{
    name: "myName",
    ...
  }, {
     name: "anotherName",
     ....
  }, {
     name: "lastName",
     ....
  }} {
    t.Run(tt.name, func(t *testing.T) {
      // body
    })
}

[ivankatliarchuk]

I'm not going to touch it, not because against, mainly due to consistency. There is not a single test with this design at the moment

[szuecs]

I would drop the whitespaces here and let gofmt/goimports group the imports

[ivankatliarchuk]

done

[szuecs]

drop whitespace

[ivankatliarchuk]

done

[szuecs]

We could omit the log and log only in the caller or change the error log to a proper style:
"Failed to .." is a good prefix for error logs.
Example:

log.Errorf("Failed to list labels for services in namespace %q: %v", namespace, err)

or return error:

return fmt.Errorf("failed to list labels for services in namespace %q: %w", namespace, err)

I would prefer return the error and drop the log, because of imports.

[ivankatliarchuk]

done

[ivankatliarchuk]

rebased with master. just to make sure latest changes do not break anything

[Raffo]

I'd also love to see the name "utils" go away, a relatively known blogpost on the topic: https://dave.cheney.net/2019/01/08/avoid-package-names-like-base-util-or-common

[ivankatliarchuk]

@Raffo do you mean to move everything back from utils to source.go?

[szuecs]

@Raffo do you mean to move everything back from utils to source.go?

If the only user is in source package you can put it in source/util.go

[ivankatliarchuk]

Ok. I give it a try

[Raffo]

Yeah what I really don't like is having a generic package that is called utils. It basically tells nothing about what it is supposed to do and it often becomes a bag with everything inside. I know kubernetes has adopted patterns like util and hack and so on, but those patterns are IMO pretty bad and I don't think we have to copy them only because the kube core contributors 10 years ago went with similar decisions.

[ivankatliarchuk]

Hi @szuecs and @Raffo utils removed