[LFX-23Q1]: Improve code quality and add unit tests of chaos center components.

[imrajdas]

Feature requests:

• Improve code quality of golang components of chaos center components
  • Run golangci-lint to list all the issues in the codebase
  • Use this tool also- https://deepsource.io/
• Add unit test cases for the backend components
  • Currently, the golang components are not using the interface, so mocking MongoDB and k8s makes it difficult.
  • Use https://github.com/stretchr/testify to mock external calls. Sample code- https://github.com/viniciuswebdev/golang-unit-tests

Components:

• GraphQL-Server: https://github.com/litmuschaos/litmus/tree/master/litmus-portal/graphql-server
• Subscriber: https://github.com/litmuschaos/litmus/tree/master/litmus-portal/cluster-agents/subscriber
• AuthServer: https://github.com/litmuschaos/litmus/tree/master/litmus-portal/authentication
• Event tracker: https://github.com/litmuschaos/litmus/tree/master/litmus-portal/cluster-agents/event-tracker

[anurag-rajawat]

Hi @imrajdas
I'm interested to work on this project. I've already worked on unit tests as a GSoC' 22 mentee
I would like to work on this as an lfx mentee. Can you give me a brief idea about the prerequisites needed to learn and is there anything else that needs to be looked into?

[imrajdas]

Hey @anurag-rajawat, please apply at lfx mentorship portal. We will review all the applications.

https://lfx.linuxfoundation.org/tools/mentorship/

To learn about litmus chaos, please go through docs and youtube videos

[anurag-rajawat]

Hey @imrajdas, how can we verify the changes made to backend components as we currently don't have any tests?
And how are you all verifying your changes?

[neelanjan00]

@anurag-rajawat please refer here: https://github.com/litmuschaos/litmus-e2e

[SAEb-ai]

Hi @imrajdas, I am interested to contribute to this project under the LFX mentorship program and hence I applied to it now. Earlier, I have been a Google Summer of Code Mentor for a project that was related to end to end tests and hence I think this project somewhat suits my skill sets. Thanks!!

[AnirudhBot]

Hey everyone! I have been exploring litmuschaos for a couple of weeks now and I have applied to be a mentee for this project under LFX mentorship. Looking forward to collaborate on this issue and eventually many more!

[abhinandanudupa]

How do I resolve this:

pkg/utils/grpc.go:13:30: SA4009: argument conn is overwritten before first use (staticcheck)
func GetProjectGRPCSvcClient(conn *grpc.ClientConn) (grpc2.ProjectClient, *grpc.ClientConn) {
                             ^

In litmus-portal/authentication/pkg/utils/grpc.go

// GetProjectGRPCSvcClient returns an RPC client for Project service
func GetProjectGRPCSvcClient(conn *grpc.ClientConn) (grpc2.ProjectClient, *grpc.ClientConn) {
  litmusGqlGrpcEndpoint := os.Getenv("LITMUS_GQL_GRPC_ENDPOINT")
  litmusGqlGrpcPort := os.Getenv("LITMUS_GQL_GRPC_PORT")

  if litmusGqlGrpcEndpoint == "" {
    litmusGqlGrpcEndpoint = DefaultLitmusGqlGrpcEndpoint
  }
  if litmusGqlGrpcPort == "" {
    litmusGqlGrpcPort = DefaultLitmusGqlGrpcPort
  }

  conn, err := grpc.Dial(litmusGqlGrpcEndpoint+litmusGqlGrpcPort, grpc.WithInsecure(), grpc.WithBlock())
  if err != nil {
    logrus.Fatalf("did not connect: %s", err)
  }

  return grpc2.NewProjectClient(conn), conn
}

If we are not using conn *grpc.ClientConn then shouldn't we remove it? It will cause a breaking change.

[abhinandanudupa]

Looks like we have to take care of cancelling the context in litmus-portal/authentication/pkg/utils/grpc.go:

pkg/utils/mongo_database.go:16:7: lostcancel: the cancel function returned by context.WithTimeout should be called, not discarded, to avoid a context leak (govet)
	ctx, _ := context.WithTimeout(context.Background(), 10*time.Second)
	     ^

There are possible leaks:

• https://stackoverflow.com/questions/72593271/context-withtimeout-without-calling-cancel/72593515#72593515
• https://stackoverflow.com/questions/44393995/what-happens-if-i-dont-cancel-a-context

[imrajdas]

This issue has been closed. @namkyu1999 has resolved the LFX issues.