From 234cd4ffc2d1e148b5263c867c8853c53fabcc17 Mon Sep 17 00:00:00 2001 From: Chongzhi Deng <57183262+BruceAko@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:09:31 +0800 Subject: [PATCH] Fix typos in src/common (#20861) Signed-off-by: BruceAko --- src/common/api/base.go | 6 +++--- src/common/const.go | 2 +- src/common/http/tls.go | 2 +- src/common/job/client.go | 2 +- src/common/job/models/models.go | 4 ++-- src/common/models/job.go | 2 +- src/common/models/uaa.go | 2 +- src/common/rbac/project/evaluator_test.go | 8 ++++---- src/common/secret/request.go | 2 +- src/common/utils/email/mail.go | 4 ++-- src/common/utils/email/mail_test.go | 4 ++-- src/common/utils/encrypt.go | 4 ++-- src/common/utils/passports.go | 4 ++-- src/common/utils/test/config.go | 2 +- src/common/utils/test/test.go | 6 +++--- src/common/utils/utils.go | 4 ++-- src/server/route.go | 2 +- 17 files changed, 30 insertions(+), 30 deletions(-) diff --git a/src/common/api/base.go b/src/common/api/base.go index 116883ae7..d2b18c251 100644 --- a/src/common/api/base.go +++ b/src/common/api/base.go @@ -116,9 +116,9 @@ func (b *BaseAPI) DecodeJSONReqAndValidate(v interface{}) (bool, error) { } // Redirect does redirection to resource URI with http header status code. -func (b *BaseAPI) Redirect(statusCode int, resouceID string) { +func (b *BaseAPI) Redirect(statusCode int, resourceID string) { requestURI := b.Ctx.Request.RequestURI - resourceURI := requestURI + "/" + resouceID + resourceURI := requestURI + "/" + resourceID b.Ctx.Redirect(statusCode, resourceURI) } @@ -138,7 +138,7 @@ func (b *BaseAPI) GetIDFromURL() (int64, error) { return id, nil } -// SetPaginationHeader set"Link" and "X-Total-Count" header for pagination request +// SetPaginationHeader set "Link" and "X-Total-Count" header for pagination request func (b *BaseAPI) SetPaginationHeader(total, page, pageSize int64) { b.Ctx.ResponseWriter.Header().Set("X-Total-Count", strconv.FormatInt(total, 10)) diff --git a/src/common/const.go b/src/common/const.go index 224a2e4f3..a8166cea3 100644 --- a/src/common/const.go +++ b/src/common/const.go @@ -152,7 +152,7 @@ const ( OIDCCallbackPath = "/c/oidc/callback" OIDCLoginPath = "/c/oidc/login" - AuthProxyRediretPath = "/c/authproxy/redirect" + AuthProxyRedirectPath = "/c/authproxy/redirect" // Global notification enable configuration NotificationEnable = "notification_enable" diff --git a/src/common/http/tls.go b/src/common/http/tls.go index 607529bf8..05a8ad044 100644 --- a/src/common/http/tls.go +++ b/src/common/http/tls.go @@ -48,7 +48,7 @@ func GetInternalCertPair() (tls.Certificate, error) { // GetInternalTLSConfig return a tls.Config for internal https communicate func GetInternalTLSConfig() (*tls.Config, error) { - // genrate key pair + // generate key pair cert, err := GetInternalCertPair() if err != nil { return nil, fmt.Errorf("internal TLS enabled but can't get cert file %w", err) diff --git a/src/common/job/client.go b/src/common/job/client.go index 74a95239e..95a22b1d7 100644 --- a/src/common/job/client.go +++ b/src/common/job/client.go @@ -151,7 +151,7 @@ func (d *DefaultClient) SubmitJob(jd *models.JobData) (string, error) { return stats.Stats.JobID, nil } -// GetJobLog call jobserivce API to get the log of a job. It only accepts the UUID of the job +// GetJobLog call jobservice API to get the log of a job. It only accepts the UUID of the job func (d *DefaultClient) GetJobLog(uuid string) ([]byte, error) { url := d.endpoint + "/api/v1/jobs/" + uuid + "/log" req, err := http.NewRequest(http.MethodGet, url, nil) diff --git a/src/common/job/models/models.go b/src/common/job/models/models.go index f114971c2..8d13bd628 100644 --- a/src/common/job/models/models.go +++ b/src/common/job/models/models.go @@ -62,7 +62,7 @@ type StatsInfo struct { UpstreamJobID string `json:"upstream_job_id,omitempty"` // Ref the upstream job if existing NumericPID int64 `json:"numeric_policy_id,omitempty"` // The numeric policy ID of the periodic job Parameters Parameters `json:"parameters,omitempty"` - Revision int64 `json:"revision,omitempty"` // For differentiating the each retry of the same job + Revision int64 `json:"revision,omitempty"` // For differentiating each retry of the same job } // JobPoolStats represents the healthy and status of all the running worker pools. @@ -70,7 +70,7 @@ type JobPoolStats struct { Pools []*JobPoolStatsData `json:"worker_pools"` } -// JobPoolStatsData represent the healthy and status of the worker worker. +// JobPoolStatsData represent the healthy and status of the worker. type JobPoolStatsData struct { WorkerPoolID string `json:"worker_pool_id"` StartedAt int64 `json:"started_at"` diff --git a/src/common/models/job.go b/src/common/models/job.go index 3dc0a4f50..064563f58 100644 --- a/src/common/models/job.go +++ b/src/common/models/job.go @@ -29,7 +29,7 @@ const ( JobCanceled string = "canceled" // JobRetrying indicate the job needs to be retried, it will be scheduled to the end of job queue by statemachine after an interval. JobRetrying string = "retrying" - // JobContinue is the status returned by statehandler to tell statemachine to move to next possible state based on trasition table. + // JobContinue is the status returned by statehandler to tell statemachine to move to next possible state based on transition table. JobContinue string = "_continue" // JobScheduled ... JobScheduled string = "scheduled" diff --git a/src/common/models/uaa.go b/src/common/models/uaa.go index 0047b894c..a901da947 100644 --- a/src/common/models/uaa.go +++ b/src/common/models/uaa.go @@ -14,7 +14,7 @@ package models -// UAASettings wraps the configuraations to access UAA service +// UAASettings wraps the configurations to access UAA service type UAASettings struct { Endpoint string ClientID string diff --git a/src/common/rbac/project/evaluator_test.go b/src/common/rbac/project/evaluator_test.go index bc29b6612..5a995fa8e 100644 --- a/src/common/rbac/project/evaluator_test.go +++ b/src/common/rbac/project/evaluator_test.go @@ -87,8 +87,8 @@ func TestProjectRoleAccess(t *testing.T) { Username: "username", } evaluator := NewEvaluator(ctl, NewBuilderForUser(user, ctl)) - resorce := NewNamespace(public.ProjectID).Resource(rbac.ResourceRepository) - assert.True(evaluator.HasPermission(context.TODO(), resorce, rbac.ActionPush)) + resource := NewNamespace(public.ProjectID).Resource(rbac.ResourceRepository) + assert.True(evaluator.HasPermission(context.TODO(), resource, rbac.ActionPush)) } { @@ -101,8 +101,8 @@ func TestProjectRoleAccess(t *testing.T) { Username: "username", } evaluator := NewEvaluator(ctl, NewBuilderForUser(user, ctl)) - resorce := NewNamespace(public.ProjectID).Resource(rbac.ResourceRepository) - assert.False(evaluator.HasPermission(context.TODO(), resorce, rbac.ActionPush)) + resource := NewNamespace(public.ProjectID).Resource(rbac.ResourceRepository) + assert.False(evaluator.HasPermission(context.TODO(), resource, rbac.ActionPush)) } } diff --git a/src/common/secret/request.go b/src/common/secret/request.go index f1cb6be02..36be468dc 100644 --- a/src/common/secret/request.go +++ b/src/common/secret/request.go @@ -25,7 +25,7 @@ import ( const HeaderPrefix = "Harbor-Secret " // FromRequest tries to get Harbor Secret from request header. -// It will return empty string if the reqeust is nil. +// It will return empty string if the request is nil. func FromRequest(req *http.Request) string { if req == nil { return "" diff --git a/src/common/utils/email/mail.go b/src/common/utils/email/mail.go index 18006b9b5..8f49c254f 100644 --- a/src/common/utils/email/mail.go +++ b/src/common/utils/email/mail.go @@ -70,7 +70,7 @@ func Send(addr, identity, username, password string, // Ping tests the connection and authentication with email server // If tls is true, a secure connection is established, or Ping -// trys to upgrate the insecure connection to a secure one if +// trys to upgrade the insecure connection to a secure one if // email server supports it. // Ping doesn't verify the server's certificate and hostname when // needed if the parameter insecure is ture @@ -119,7 +119,7 @@ func newClient(addr, identity, username, password string, return nil, err } - // try to swith to SSL/TLS + // try to switch to SSL/TLS if !tls { if ok, _ := client.Extension("STARTTLS"); ok { log.Debugf("switching the connection with %s to SSL/TLS ...", addr) diff --git a/src/common/utils/email/mail_test.go b/src/common/utils/email/mail_test.go index e9ad10b66..35e09b335 100644 --- a/src/common/utils/email/mail_test.go +++ b/src/common/utils/email/mail_test.go @@ -38,7 +38,7 @@ func TestSend(t *testing.T) { err := Send(addr, identity, username, password, timeout, tls, insecure, from, to, subject, message) - // bypass the check due to securty policy change on gmail + // bypass the check due to security policy change on gmail // TODO // assert.Nil(t, err) @@ -78,7 +78,7 @@ func TestPing(t *testing.T) { // tls connection err := Ping(addr, identity, username, password, timeout, tls, insecure) - // bypass the check due to securty policy change on gmail + // bypass the check due to security policy change on gmail // TODO // assert.Nil(t, err) diff --git a/src/common/utils/encrypt.go b/src/common/utils/encrypt.go index 73a7cbec6..6bfd6b945 100644 --- a/src/common/utils/encrypt.go +++ b/src/common/utils/encrypt.go @@ -46,8 +46,8 @@ var HashAlg = map[string]func() hash.Hash{ } // Encrypt encrypts the content with salt -func Encrypt(content string, salt string, encrptAlg string) string { - return fmt.Sprintf("%x", pbkdf2.Key([]byte(content), []byte(salt), 4096, 16, HashAlg[encrptAlg])) +func Encrypt(content string, salt string, encryptAlg string) string { + return fmt.Sprintf("%x", pbkdf2.Key([]byte(content), []byte(salt), 4096, 16, HashAlg[encryptAlg])) } // ReversibleEncrypt encrypts the str with aes/base64 diff --git a/src/common/utils/passports.go b/src/common/utils/passports.go index c50cd79bf..bf08c8ad8 100644 --- a/src/common/utils/passports.go +++ b/src/common/utils/passports.go @@ -72,7 +72,7 @@ func (p *passportsPool) Revoke() bool { type LimitedConcurrentRunner interface { // AddTask adds a task to run AddTask(task func() error) - // Wait waits all the tasks to be finished, returns error if the any of the tasks gets error + // Wait waits all the tasks to be finished, returns error if any of the tasks gets error Wait() (err error) // Cancel cancels all tasks, tasks that already started will continue to run Cancel(err error) @@ -106,7 +106,7 @@ func (r *limitedConcurrentRunner) AddTask(task func() error) { r.wg.Done() }() - // Return false means no passport acquired, and no valid passport will be dispatched any more. + // Return false means no passport acquired, and no valid passport will be dispatched anymore. // For example, some crucial errors happened and all tasks should be cancelled. if ok := r.passportsPool.Apply(); !ok { return diff --git a/src/common/utils/test/config.go b/src/common/utils/test/config.go index cfc0780dc..62e557f6b 100644 --- a/src/common/utils/test/config.go +++ b/src/common/utils/test/config.go @@ -65,7 +65,7 @@ var defaultConfig = map[string]interface{}{ common.RobotNamePrefix: "robot$", } -// GetDefaultConfigMap returns the defailt config map for easier modification. +// GetDefaultConfigMap returns the default config map for easier modification. func GetDefaultConfigMap() map[string]interface{} { return defaultConfig } diff --git a/src/common/utils/test/test.go b/src/common/utils/test/test.go index ba6758130..bbf8623cf 100644 --- a/src/common/utils/test/test.go +++ b/src/common/utils/test/test.go @@ -55,11 +55,11 @@ type Response struct { StatusCode int // Headers are the headers of the response Headers map[string]string - // Boby is the body of the response + // Body is the body of the response Body []byte } -// Handler returns a handler function which handle requst according to +// Handler returns a handler function which handle request according to // the response provided func Handler(resp *Response) func(http.ResponseWriter, *http.Request) { return func(w http.ResponseWriter, r *http.Request) { @@ -82,7 +82,7 @@ func Handler(resp *Response) func(http.ResponseWriter, *http.Request) { } } -// NewServer creates a HTTP server for unit test +// NewServer creates an HTTP server for unit test func NewServer(mappings ...*RequestHandlerMapping) *httptest.Server { r := mux.NewRouter() diff --git a/src/common/utils/utils.go b/src/common/utils/utils.go index 9a7a1f07c..2a3a37289 100644 --- a/src/common/utils/utils.go +++ b/src/common/utils/utils.go @@ -89,7 +89,7 @@ func GenerateRandomString() string { // TestTCPConn tests TCP connection // timeout: the total time before returning if something is wrong // with the connection, in second -// interval: the interval time for retring after failure, in second +// interval: the interval time for retrying after failure, in second func TestTCPConn(addr string, timeout, interval int) error { success := make(chan int, 1) cancel := make(chan int, 1) @@ -176,7 +176,7 @@ func ParseProjectIDOrName(value interface{}) (int64, string, error) { return id, name, nil } -// SafeCastString -- cast a object to string saftely +// SafeCastString -- cast an object to string safely func SafeCastString(value interface{}) string { if result, ok := value.(string); ok { return result diff --git a/src/server/route.go b/src/server/route.go index 7a9f03b70..76cbafc18 100644 --- a/src/server/route.go +++ b/src/server/route.go @@ -42,7 +42,7 @@ func registerRoutes() { web.Router(common.OIDCLoginPath, &controllers.OIDCController{}, "get:RedirectLogin") web.Router("/c/oidc/onboard", &controllers.OIDCController{}, "post:Onboard") web.Router(common.OIDCCallbackPath, &controllers.OIDCController{}, "get:Callback") - web.Router(common.AuthProxyRediretPath, &controllers.AuthProxyController{}, "get:HandleRedirect") + web.Router(common.AuthProxyRedirectPath, &controllers.AuthProxyController{}, "get:HandleRedirect") web.Router("/api/internal/renameadmin", &api.InternalAPI{}, "post:RenameAdmin") web.Router("/api/internal/syncquota", &api.InternalAPI{}, "post:SyncQuota")