Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(server): refactoring analyzer files to comply with resources standard #2810

Merged
merged 4 commits into from
Jun 22, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions server/app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
httpServer "github.com/kubeshop/tracetest/server/http"
"github.com/kubeshop/tracetest/server/http/mappings"
"github.com/kubeshop/tracetest/server/http/websocket"
linterResource "github.com/kubeshop/tracetest/server/linter/resource"
analyzer "github.com/kubeshop/tracetest/server/linter/analyzer"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need to use the alias if the alias has the same name as the package. You can remove them all

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Also updating it.

"github.com/kubeshop/tracetest/server/model"
"github.com/kubeshop/tracetest/server/openapi"
"github.com/kubeshop/tracetest/server/otlp"
Expand Down Expand Up @@ -197,7 +197,7 @@ func (app *App) Start(opts ...appOption) error {
pollingProfileRepo := pollingprofile.NewRepository(db)
dataStoreRepo := datastore.NewRepository(db)
environmentRepo := environment.NewRepository(db)
linterRepo := linterResource.NewRepository(db)
linterRepo := analyzer.NewRepository(db)

eventEmitter := executor.NewEventEmitter(testDB, subscriptionManager)
registerOtlpServer(app, testDB, eventEmitter, dataStoreRepo)
Expand Down Expand Up @@ -268,7 +268,7 @@ func (app *App) Start(opts ...appOption) error {
registerDemosResource(demoRepo, apiRouter, db, provisioner, tracer)

registerDataStoreResource(dataStoreRepo, apiRouter, db, provisioner, tracer)
registerlinterResource(linterRepo, apiRouter, db, provisioner, tracer)
registerAnalyzerResource(linterRepo, apiRouter, db, provisioner, tracer)

isTracetestDev := os.Getenv("TRACETEST_DEV") != ""
registerSPAHandler(router, app.cfg, configFromDB.IsAnalyticsEnabled(), serverID, isTracetestDev)
Expand Down Expand Up @@ -356,12 +356,12 @@ func registerOtlpServer(app *App, testDB model.Repository, eventEmitter executor
})
}

func registerlinterResource(linterRepo *linterResource.Repository, router *mux.Router, db *sql.DB, provisioner *provisioning.Provisioner, tracer trace.Tracer) {
manager := resourcemanager.New[linterResource.Linter](
linterResource.ResourceName,
linterResource.ResourceNamePlural,
func registerAnalyzerResource(linterRepo *analyzer.Repository, router *mux.Router, db *sql.DB, provisioner *provisioning.Provisioner, tracer trace.Tracer) {
manager := resourcemanager.New[analyzer.Linter](
analyzer.ResourceName,
analyzer.ResourceNamePlural,
linterRepo,
resourcemanager.WithOperations(linterResource.Operations...),
resourcemanager.WithOperations(analyzer.Operations...),
resourcemanager.WithTracer(tracer),
)
manager.RegisterRoutes(router)
Expand Down
4 changes: 2 additions & 2 deletions server/app/facade.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/kubeshop/tracetest/server/executor"
"github.com/kubeshop/tracetest/server/executor/pollingprofile"
"github.com/kubeshop/tracetest/server/executor/trigger"
linterResource "github.com/kubeshop/tracetest/server/linter/resource"
analyzer "github.com/kubeshop/tracetest/server/linter/analyzer"
mathnogueira marked this conversation as resolved.
Show resolved Hide resolved
"github.com/kubeshop/tracetest/server/model"
"github.com/kubeshop/tracetest/server/pkg/id"
"github.com/kubeshop/tracetest/server/subscription"
Expand Down Expand Up @@ -53,7 +53,7 @@ func (rf runnerFacade) RunAssertions(ctx context.Context, request executor.Asser
func newRunnerFacades(
ppRepo *pollingprofile.Repository,
dsRepo *datastore.Repository,
lintRepo *linterResource.Repository,
lintRepo *analyzer.Repository,
testDB model.Repository,
transactionRunRepository *transaction.RunRepository,
appTracer trace.Tracer,
Expand Down
42 changes: 21 additions & 21 deletions server/executor/linter_runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/linter"
linterResource "github.com/kubeshop/tracetest/server/linter/resource"
analyzerResource "github.com/kubeshop/tracetest/server/linter/analyzer"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be just analyzer? is there a reason for the alias?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I'll update it.

"github.com/kubeshop/tracetest/server/model"
"github.com/kubeshop/tracetest/server/model/events"
"github.com/kubeshop/tracetest/server/subscription"
Expand All @@ -32,18 +32,18 @@ type LinterRunner interface {
WorkerPool
}

type LinterResourceGetter interface {
GetDefault(ctx context.Context) linterResource.Linter
type AnalyzerGetter interface {
GetDefault(ctx context.Context) analyzerResource.Linter
}

type defaultlinterRunner struct {
updater RunUpdater
inputChannel chan LinterRequest
exitChannel chan bool
subscriptionManager *subscription.Manager
eventEmitter EventEmitter
linterResourceGetter LinterResourceGetter
assertionRunner AssertionRunner
updater RunUpdater
inputChannel chan LinterRequest
exitChannel chan bool
subscriptionManager *subscription.Manager
eventEmitter EventEmitter
analyzerGetter AnalyzerGetter
assertionRunner AssertionRunner
}

var _ WorkerPool = &defaultlinterRunner{}
Expand All @@ -54,15 +54,15 @@ func NewlinterRunner(
subscriptionManager *subscription.Manager,
eventEmitter EventEmitter,
assertionRunner AssertionRunner,
linterResourceGetter LinterResourceGetter,
analyzerGetter AnalyzerGetter,
) LinterRunner {
return &defaultlinterRunner{
updater: updater,
inputChannel: make(chan LinterRequest, 1),
subscriptionManager: subscriptionManager,
eventEmitter: eventEmitter,
assertionRunner: assertionRunner,
linterResourceGetter: linterResourceGetter,
updater: updater,
inputChannel: make(chan LinterRequest, 1),
subscriptionManager: subscriptionManager,
eventEmitter: eventEmitter,
assertionRunner: assertionRunner,
analyzerGetter: analyzerGetter,
}
}

Expand Down Expand Up @@ -99,8 +99,8 @@ func (e *defaultlinterRunner) startWorker() {

func (e *defaultlinterRunner) onRequest(request LinterRequest) {
ctx := request.Context()
lintResource := e.linterResourceGetter.GetDefault(ctx)
linter := linter.Newlinter(lintResource, linter.AvailablePlugins...)
lintResource := e.analyzerGetter.GetDefault(ctx)
linter := linter.NewLinter(lintResource, linter.AvailablePlugins...)

shouldSkip, reason := linter.ShouldSkip()
if shouldSkip {
Expand Down Expand Up @@ -153,7 +153,7 @@ func (e *defaultlinterRunner) onFinish(ctx context.Context, request LinterReques
e.assertionRunner.RunAssertions(ctx, assertionRequest)
}

func (e *defaultlinterRunner) onRun(ctx context.Context, request LinterRequest, linter linter.Linter, linterResource linterResource.Linter) (model.Run, error) {
func (e *defaultlinterRunner) onRun(ctx context.Context, request LinterRequest, linter linter.Linter, analyzerResource analyzerResource.Linter) (model.Run, error) {
run := request.Run
log.Printf("[linterRunner] Test %s Run %d: Starting\n", request.Test.ID, request.Run.ID)

Expand All @@ -167,7 +167,7 @@ func (e *defaultlinterRunner) onRun(ctx context.Context, request LinterRequest,
return e.onError(ctx, request, run, err)
}

result.MinimumScore = linterResource.MinimumScore
result.MinimumScore = analyzerResource.MinimumScore
run = run.SuccessfulLinterExecution(result)
err = e.updater.Update(ctx, run)
if err != nil {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
package linter_resource
package analyzer

import (
"fmt"

"github.com/kubeshop/tracetest/server/pkg/id"
"github.com/kubeshop/tracetest/server/resourcemanager"
)

const (
ResourceName = "Analyzer"
ResourceNamePlural = "Analyzers"
)

var Operations = []resourcemanager.Operation{
resourcemanager.OperationGet,
resourcemanager.OperationList,
resourcemanager.OperationUpdate,
}

type (
Linter struct {
ID id.ID `json:"id"`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package linter_resource
package analyzer

import (
"context"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
package linter_resource_test
package analyzer_test

import (
"database/sql"
"testing"

"github.com/gorilla/mux"
linter_resource "github.com/kubeshop/tracetest/server/linter/resource"
analyzer "github.com/kubeshop/tracetest/server/linter/analyzer"
"github.com/kubeshop/tracetest/server/resourcemanager"
mathnogueira marked this conversation as resolved.
Show resolved Hide resolved
rmtests "github.com/kubeshop/tracetest/server/resourcemanager/testutil"
)

func TestlinterResource(t *testing.T) {
rmtests.TestResourceType(t, rmtests.ResourceTypeTest{
ResourceTypeSingular: linter_resource.ResourceName,
ResourceTypePlural: linter_resource.ResourceNamePlural,
ResourceTypeSingular: analyzer.ResourceName,
ResourceTypePlural: analyzer.ResourceNamePlural,
RegisterManagerFn: func(router *mux.Router, db *sql.DB) resourcemanager.Manager {
repo := linter_resource.NewRepository(db)
repo := analyzer.NewRepository(db)

manager := resourcemanager.New[linter_resource.Linter](
linter_resource.ResourceName,
linter_resource.ResourceNamePlural,
manager := resourcemanager.New[analyzer.Linter](
analyzer.ResourceName,
analyzer.ResourceNamePlural,
repo,
resourcemanager.WithOperations(linter_resource.Operations...),
resourcemanager.WithOperations(analyzer.Operations...),
)
manager.RegisterRoutes(router)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package linter_resource_test
package analyzer_test

import (
"os"
Expand Down
6 changes: 3 additions & 3 deletions server/linter/linter.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ import (
"context"
"fmt"

analyzer "github.com/kubeshop/tracetest/server/linter/analyzer"
mathnogueira marked this conversation as resolved.
Show resolved Hide resolved
linter_plugin_common "github.com/kubeshop/tracetest/server/linter/plugins/common"
linter_plugin_security "github.com/kubeshop/tracetest/server/linter/plugins/security"
linter_plugin_standards "github.com/kubeshop/tracetest/server/linter/plugins/standards"
linter_resource "github.com/kubeshop/tracetest/server/linter/resource"
"github.com/kubeshop/tracetest/server/model"
)

Expand All @@ -27,10 +27,10 @@ type Linter interface {

type linter struct {
plugins []model.Plugin
linterResource linter_resource.Linter
linterResource analyzer.Linter
}

func Newlinter(linterResource linter_resource.Linter, plugins ...model.Plugin) linter {
func NewLinter(linterResource analyzer.Linter, plugins ...model.Plugin) Linter {
return linter{plugins, linterResource}
}

Expand Down
14 changes: 0 additions & 14 deletions server/linter/resource/resource.go

This file was deleted.