From 3d3123f6e96a91db935ece49a29701360e764392 Mon Sep 17 00:00:00 2001 From: Youngteac Hong Date: Sat, 8 Oct 2022 20:00:34 +0900 Subject: [PATCH] Bump up Go to 1.19.2 (#425) * Bump up Go to 1.19.2 * Bump up golangci-lint to 1.50.0 and fix lint errors --- .github/workflows/ci.yml | 2 +- .github/workflows/docker-publish-latest.yml | 4 ++-- .github/workflows/docker-publish.yml | 4 ++-- .golangci.yml | 5 +++++ Makefile | 2 +- admin/client.go | 1 + api/converter/converter.go | 2 ++ api/types/id.go | 2 ++ client/client.go | 2 ++ cmd/yorkie/commands.go | 1 + cmd/yorkie/config/config.go | 1 + cmd/yorkie/document/document.go | 1 + cmd/yorkie/project/project.go | 1 + go.mod | 2 +- internal/version/version.go | 17 +++++++++++++++++ pkg/cache/cache.go | 1 + pkg/document/change/change.go | 2 ++ pkg/document/crdt/root.go | 3 +++ pkg/document/document.go | 1 + pkg/document/json/json.go | 1 + pkg/document/key/key.go | 1 + pkg/document/operations/operation.go | 2 ++ pkg/document/time/ticket.go | 1 + pkg/llrb/llrb.go | 1 + pkg/pq/priority_queue.go | 1 + pkg/splay/splay.go | 6 ++++-- pkg/units/duration.go | 4 +++- server/admin/auth/token_manager.go | 1 + server/admin/interceptors/default.go | 1 + server/admin/server.go | 1 + server/backend/backend.go | 3 +++ server/backend/background/background.go | 18 ++++++++++++++++++ server/backend/database/database.go | 1 + server/backend/database/memory/database.go | 1 + server/backend/database/mongo/client.go | 1 + server/backend/housekeeping/housekeeping.go | 3 +++ server/backend/sync/coordinator.go | 1 + server/backend/sync/etcd/client.go | 2 ++ server/backend/sync/memory/coordinator.go | 1 + server/clients/clients.go | 1 + server/documents/documents.go | 1 + server/grpchelper/logging.go | 17 +++++++++++++++++ server/logging/context.go | 16 ++++++++++++++++ server/logging/logging.go | 1 + server/packs/packs.go | 2 ++ server/profiling/config.go | 1 + server/profiling/prometheus/metrics.go | 1 + server/projects/projects.go | 1 + server/rpc/auth/auth.go | 1 + server/rpc/interceptors/context.go | 1 + server/rpc/metadata/context.go | 1 + server/rpc/server.go | 2 ++ server/server.go | 3 +++ server/users/context.go | 16 ++++++++++++++++ server/users/users.go | 1 + test/helper/helper.go | 1 + 56 files changed, 162 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 35448c4d0..f9d8f886c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: strategy: matrix: go_version: - - '1.18' + - 1.19.2 runs-on: ubuntu-latest steps: diff --git a/.github/workflows/docker-publish-latest.yml b/.github/workflows/docker-publish-latest.yml index 0cd98d1c4..377fea237 100644 --- a/.github/workflows/docker-publish-latest.yml +++ b/.github/workflows/docker-publish-latest.yml @@ -9,10 +9,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Set up Go 1.x + - name: Set up Go 1.19.2 uses: actions/setup-go@v2 with: - go-version: 1.18 + go-version: 1.19.2 - name: Check out code uses: actions/checkout@v2 diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 338e0b179..146961826 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -8,10 +8,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Set up Go 1.x + - name: Set up Go 1.19.2 uses: actions/setup-go@v2 with: - go-version: 1.18 + go-version: 1.19.2 - name: Check out code uses: actions/checkout@v2 diff --git a/.golangci.yml b/.golangci.yml index 462e30f78..23e5f99da 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -37,3 +37,8 @@ linters-settings: issues: exclude-use-default: false + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + - text: "G112:" + linters: + - gosec diff --git a/Makefile b/Makefile index 60e70f4b9..be4978ecb 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ default: help tools: ## install tools for developing yorkie go install github.com/gogo/protobuf/protoc-gen-gogo@v1.3.2 go install github.com/gogo/protobuf/protoc-gen-gofast@v1.3.2 - go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.46.2 + go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.50.0 proto: ## generate proto files protoc \ diff --git a/admin/client.go b/admin/client.go index 9ee3d048c..d633650b5 100644 --- a/admin/client.go +++ b/admin/client.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package admin provides the client for the admin service. package admin import ( diff --git a/api/converter/converter.go b/api/converter/converter.go index 433176600..0dd71cdbd 100644 --- a/api/converter/converter.go +++ b/api/converter/converter.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package converter provides the converter for converting model to +// Protobuf, bytes and vice versa. package converter import "errors" diff --git a/api/types/id.go b/api/types/id.go index 26dcf657c..6799701b8 100644 --- a/api/types/id.go +++ b/api/types/id.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package types provides the types used in the Yorkie API. This package is +// used by both the server and the client. package types import ( diff --git a/client/client.go b/client/client.go index 4a71b6f97..d14f2edf7 100644 --- a/client/client.go +++ b/client/client.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package client provides the client implementation of Yorkie. It is used to +// connect to the server and attach documents. package client import ( diff --git a/cmd/yorkie/commands.go b/cmd/yorkie/commands.go index f7cf3cf0a..6c4dbabf3 100644 --- a/cmd/yorkie/commands.go +++ b/cmd/yorkie/commands.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package main is the entry point of the Yorkie CLI. package main import ( diff --git a/cmd/yorkie/config/config.go b/cmd/yorkie/config/config.go index a2522e678..fadff71cc 100644 --- a/cmd/yorkie/config/config.go +++ b/cmd/yorkie/config/config.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package config provides the configuration for Admin server. package config import ( diff --git a/cmd/yorkie/document/document.go b/cmd/yorkie/document/document.go index 2ba27dc79..cdc10a930 100644 --- a/cmd/yorkie/document/document.go +++ b/cmd/yorkie/document/document.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package document provides the document command. package document import "github.com/spf13/cobra" diff --git a/cmd/yorkie/project/project.go b/cmd/yorkie/project/project.go index 2f243b05f..4e45ed7fa 100644 --- a/cmd/yorkie/project/project.go +++ b/cmd/yorkie/project/project.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package project provides the project command. package project import "github.com/spf13/cobra" diff --git a/go.mod b/go.mod index e8d89626f..1850f751f 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ module github.com/yorkie-team/yorkie -go 1.18 +go 1.19 require ( bou.ke/monkey v1.0.2 diff --git a/internal/version/version.go b/internal/version/version.go index 01e86111f..4645ad18c 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -1,3 +1,20 @@ +/* + * Copyright 2022 The Yorkie Authors. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Package version provides the version information of Yorkie. package version // At build time, the versions is replaced with the current version using the -X linker flag diff --git a/pkg/cache/cache.go b/pkg/cache/cache.go index 3d3bcb3c9..13beba916 100644 --- a/pkg/cache/cache.go +++ b/pkg/cache/cache.go @@ -17,6 +17,7 @@ * https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/util/cache/lruexpirecache.go */ +// Package cache provides a cache implementation. package cache import ( diff --git a/pkg/document/change/change.go b/pkg/document/change/change.go index 11259489c..ed392207f 100644 --- a/pkg/document/change/change.go +++ b/pkg/document/change/change.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package change provides the implementation of Change. Change is a set of +// operations that can be applied to a document. package change import ( diff --git a/pkg/document/crdt/root.go b/pkg/document/crdt/root.go index 37d4432d0..9d4454341 100644 --- a/pkg/document/crdt/root.go +++ b/pkg/document/crdt/root.go @@ -14,6 +14,9 @@ * limitations under the License. */ +// Package crdt provides the implementation of the CRDT data structure. +// The CRDT data structure is a data structure that can be replicated and +// shared among multiple replicas. package crdt import ( diff --git a/pkg/document/document.go b/pkg/document/document.go index 20d4129af..4345bc5a8 100644 --- a/pkg/document/document.go +++ b/pkg/document/document.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package document provides JSON-like document(CRDT) implementation. package document import ( diff --git a/pkg/document/json/json.go b/pkg/document/json/json.go index 7332a3d34..35312c61a 100644 --- a/pkg/document/json/json.go +++ b/pkg/document/json/json.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package json provides the JSON document implementation. package json import "github.com/yorkie-team/yorkie/pkg/document/crdt" diff --git a/pkg/document/key/key.go b/pkg/document/key/key.go index 76820189e..03d0285f4 100644 --- a/pkg/document/key/key.go +++ b/pkg/document/key/key.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package key provides the key implementation of the document. package key // Key represents a document key. diff --git a/pkg/document/operations/operation.go b/pkg/document/operations/operation.go index 5fefc67b8..8047f04e7 100644 --- a/pkg/document/operations/operation.go +++ b/pkg/document/operations/operation.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package operations implements the operations that can be executed on the +// document. package operations import ( diff --git a/pkg/document/time/ticket.go b/pkg/document/time/ticket.go index 69a989f11..ce206f734 100644 --- a/pkg/document/time/ticket.go +++ b/pkg/document/time/ticket.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package time provides logical clock and ticket for document. package time import ( diff --git a/pkg/llrb/llrb.go b/pkg/llrb/llrb.go index 5f417b19a..316effac0 100644 --- a/pkg/llrb/llrb.go +++ b/pkg/llrb/llrb.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package llrb provides a Left-leaning Red-Black tree implementation. package llrb import ( diff --git a/pkg/pq/priority_queue.go b/pkg/pq/priority_queue.go index 890da052e..28395e241 100644 --- a/pkg/pq/priority_queue.go +++ b/pkg/pq/priority_queue.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package pq provides the priority queue implementation. package pq import ( diff --git a/pkg/splay/splay.go b/pkg/splay/splay.go index 58b9facf3..760302cd2 100644 --- a/pkg/splay/splay.go +++ b/pkg/splay/splay.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package splay provides splay tree implementation. It is used to implement +// List by using splay tree. package splay import ( @@ -85,8 +87,7 @@ func (t *Node[V]) hasLinks() bool { } // Tree is weighted binary search tree which is based on Splay tree. -// original paper on Splay Trees: -// - https://www.cs.cmu.edu/~sleator/papers/self-adjusting.pdf +// original paper on Splay Trees: https://www.cs.cmu.edu/~sleator/papers/self-adjusting.pdf type Tree[V Value] struct { root *Node[V] } @@ -388,6 +389,7 @@ func (t *Tree[V]) rightmost() *Node[V] { return node } +// Len returns the size of this Tree. func (t *Tree[V]) Len() int { if t.root == nil { return 0 diff --git a/pkg/units/duration.go b/pkg/units/duration.go index e89332c5d..6ce9f5c98 100644 --- a/pkg/units/duration.go +++ b/pkg/units/duration.go @@ -17,6 +17,8 @@ * https://github.com/docker/go-units/blob/master/duration.go */ +// Package units provides a set of functions to convert between bytes and +// human-readable formats. package units import ( @@ -25,7 +27,7 @@ import ( ) // HumanDuration returns a human-readable approximation of a duration -// (eg. "About a minute", "4 hours ago", etc.). +// (e.g. "About a minute", "4 hours ago", etc.). func HumanDuration(d time.Duration) string { if seconds := int(d.Seconds()); seconds < 1 { return "Less than a second" diff --git a/server/admin/auth/token_manager.go b/server/admin/auth/token_manager.go index 52a5455b2..a63dc67c7 100644 --- a/server/admin/auth/token_manager.go +++ b/server/admin/auth/token_manager.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package auth provides the authentication and authorization of the admin server. package auth import ( diff --git a/server/admin/interceptors/default.go b/server/admin/interceptors/default.go index f77451b17..a2a285010 100644 --- a/server/admin/interceptors/default.go +++ b/server/admin/interceptors/default.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package interceptors provides interceptors for Admin server. package interceptors import ( diff --git a/server/admin/server.go b/server/admin/server.go index 884fb1970..5066ff161 100644 --- a/server/admin/server.go +++ b/server/admin/server.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package admin provides the admin server. package admin import ( diff --git a/server/backend/backend.go b/server/backend/backend.go index 1dbd2202e..977708188 100644 --- a/server/backend/backend.go +++ b/server/backend/backend.go @@ -14,6 +14,9 @@ * limitations under the License. */ +// Package backend provides the backend implementation of the Yorkie. +// This package is responsible for managing the database and other +// resources required to run Yorkie. package backend import ( diff --git a/server/backend/background/background.go b/server/backend/background/background.go index c33548efc..7216d2c52 100644 --- a/server/backend/background/background.go +++ b/server/backend/background/background.go @@ -1,3 +1,21 @@ +/* + * Copyright 2022 The Yorkie Authors. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Package background provides the background service. This service is used to +// manage the background goroutines in the backend. package background import ( diff --git a/server/backend/database/database.go b/server/backend/database/database.go index 8cb614029..08f388729 100644 --- a/server/backend/database/database.go +++ b/server/backend/database/database.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package database provides the database interface for the Yorkie backend. package database import ( diff --git a/server/backend/database/memory/database.go b/server/backend/database/memory/database.go index 6e5f11bdf..bc902e79a 100644 --- a/server/backend/database/memory/database.go +++ b/server/backend/database/memory/database.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package memory implements the database interface using in-memory database. package memory import ( diff --git a/server/backend/database/mongo/client.go b/server/backend/database/mongo/client.go index 0178b2c53..84ce88ba5 100644 --- a/server/backend/database/mongo/client.go +++ b/server/backend/database/mongo/client.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package mongo implements database interfaces using MongoDB. package mongo import ( diff --git a/server/backend/housekeeping/housekeeping.go b/server/backend/housekeeping/housekeeping.go index 9f0f358bb..ce6bfff2f 100644 --- a/server/backend/housekeeping/housekeeping.go +++ b/server/backend/housekeeping/housekeeping.go @@ -14,6 +14,9 @@ * limitations under the License. */ +// Package housekeeping provides the housekeeping service. The housekeeping +// service is responsible for deactivating clients that have not been used for +// a long time. package housekeeping import ( diff --git a/server/backend/sync/coordinator.go b/server/backend/sync/coordinator.go index 3abe064e3..e4a07b1a7 100644 --- a/server/backend/sync/coordinator.go +++ b/server/backend/sync/coordinator.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package sync provides the synchronization primitives for the server. package sync import ( diff --git a/server/backend/sync/etcd/client.go b/server/backend/sync/etcd/client.go index 5f5c26109..f58773ae0 100644 --- a/server/backend/sync/etcd/client.go +++ b/server/backend/sync/etcd/client.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package etcd provides etcd implementation of the sync. It is used to +// synchronize the state of the cluster. package etcd import ( diff --git a/server/backend/sync/memory/coordinator.go b/server/backend/sync/memory/coordinator.go index fc103b783..8a75437b4 100644 --- a/server/backend/sync/memory/coordinator.go +++ b/server/backend/sync/memory/coordinator.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package memory provides the memory implementation of the sync package. package memory import ( diff --git a/server/clients/clients.go b/server/clients/clients.go index 02ed21f70..ab6c6691c 100644 --- a/server/clients/clients.go +++ b/server/clients/clients.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package clients provides the client related business logic. package clients import ( diff --git a/server/documents/documents.go b/server/documents/documents.go index 2c72ffb65..b75f04955 100644 --- a/server/documents/documents.go +++ b/server/documents/documents.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package documents provides the document related business logic. package documents import ( diff --git a/server/grpchelper/logging.go b/server/grpchelper/logging.go index 00340592b..0c68ed085 100644 --- a/server/grpchelper/logging.go +++ b/server/grpchelper/logging.go @@ -1,3 +1,20 @@ +/* + * Copyright 2022 The Yorkie Authors. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Package grpchelper provides helper functions for gRPC. package grpchelper import ( diff --git a/server/logging/context.go b/server/logging/context.go index 95aeb6dd5..5e4da6f89 100644 --- a/server/logging/context.go +++ b/server/logging/context.go @@ -1,3 +1,19 @@ +/* + * Copyright 2022 The Yorkie Authors. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package logging import ( diff --git a/server/logging/logging.go b/server/logging/logging.go index ca6195ec1..1faabd318 100644 --- a/server/logging/logging.go +++ b/server/logging/logging.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package logging provides logging facilities for Yorkie Server. package logging import ( diff --git a/server/packs/packs.go b/server/packs/packs.go index 54442bf17..0f0e4a0c0 100644 --- a/server/packs/packs.go +++ b/server/packs/packs.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package packs implements PushPullPack which is used to sync the document +// between the client and the server. package packs import ( diff --git a/server/profiling/config.go b/server/profiling/config.go index 2ec2f227b..4e7cbead4 100644 --- a/server/profiling/config.go +++ b/server/profiling/config.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package profiling provides profiling server. package profiling import ( diff --git a/server/profiling/prometheus/metrics.go b/server/profiling/prometheus/metrics.go index 85728d129..e968ec8eb 100644 --- a/server/profiling/prometheus/metrics.go +++ b/server/profiling/prometheus/metrics.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package prometheus provides a Prometheus metrics exporter. package prometheus import ( diff --git a/server/projects/projects.go b/server/projects/projects.go index f593849d7..288b860f5 100644 --- a/server/projects/projects.go +++ b/server/projects/projects.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package projects provides the project related business logic. package projects import ( diff --git a/server/rpc/auth/auth.go b/server/rpc/auth/auth.go index fe17bcaf3..e6f86c7cb 100644 --- a/server/rpc/auth/auth.go +++ b/server/rpc/auth/auth.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package auth provides authentication and authorization for RPCs. package auth import ( diff --git a/server/rpc/interceptors/context.go b/server/rpc/interceptors/context.go index 016b21eee..e5ec6917a 100644 --- a/server/rpc/interceptors/context.go +++ b/server/rpc/interceptors/context.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package interceptors provides the interceptors for RPC. package interceptors import ( diff --git a/server/rpc/metadata/context.go b/server/rpc/metadata/context.go index 56c75c408..2fb202c57 100644 --- a/server/rpc/metadata/context.go +++ b/server/rpc/metadata/context.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package metadata provides metadata for RPC. package metadata import ( diff --git a/server/rpc/server.go b/server/rpc/server.go index 2f1df2f44..b9fde6461 100644 --- a/server/rpc/server.go +++ b/server/rpc/server.go @@ -14,6 +14,8 @@ * limitations under the License. */ +// Package rpc provides the rpc server which is responsible for handling +// requests from the client. package rpc import ( diff --git a/server/server.go b/server/server.go index 21934695a..edeed0ebc 100644 --- a/server/server.go +++ b/server/server.go @@ -14,6 +14,9 @@ * limitations under the License. */ +// Package server provides the Yorkie server which is the main entry point of the +// Yorkie system. The server is responsible for starting the RPC server and +// admin server. package server import ( diff --git a/server/users/context.go b/server/users/context.go index e0d5ad97d..9e4ec2d99 100644 --- a/server/users/context.go +++ b/server/users/context.go @@ -1,3 +1,19 @@ +/* + * Copyright 2022 The Yorkie Authors. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package users import ( diff --git a/server/users/users.go b/server/users/users.go index 901fdd7c1..cf158a0ae 100644 --- a/server/users/users.go +++ b/server/users/users.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package users provides the user related business logic. package users import ( diff --git a/test/helper/helper.go b/test/helper/helper.go index cb1fbbb8e..69ca83d3d 100644 --- a/test/helper/helper.go +++ b/test/helper/helper.go @@ -14,6 +14,7 @@ * limitations under the License. */ +// Package helper provides helper functions for testing. package helper import (