first attempt for knuu API #601
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,3 +5,6 @@ coverage.txt | |
| .devcontainer | ||
| Taskfile.yaml | ||
|
|
||
| bin/* | ||
| docker-compose.yml | ||
| .env | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/sirupsen/logrus" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
| "gorm.io/gorm/logger" | ||
|
|
||
| "github.com/celestiaorg/knuu/internal/api/v1" | ||
| "github.com/celestiaorg/knuu/internal/api/v1/services" | ||
| "github.com/celestiaorg/knuu/internal/database" | ||
| ) | ||
|
|
||
| const ( | ||
| apiCmdName = "api" | ||
|
|
||
| flagPort = "port" | ||
| flagAPILogLevel = "log-level" | ||
|
|
||
| flagDBHost = "db.host" | ||
| flagDBUser = "db.user" | ||
| flagDBPassword = "db.password" | ||
| flagDBName = "db.name" | ||
| flagDBPort = "db.port" | ||
|
|
||
| flagSecretKey = "secret-key" | ||
| flagAdminUser = "admin-user" | ||
| flagAdminPass = "admin-pass" | ||
|
|
||
| flagTestsLogsPath = "tests-logs-path" | ||
|
|
||
| defaultPort = 8080 | ||
| defaultLogLevel = gin.ReleaseMode | ||
|
|
||
| defaultDBHost = database.DefaultHost | ||
| defaultDBUser = database.DefaultUser | ||
| defaultDBPassword = database.DefaultPassword | ||
| defaultDBName = database.DefaultDBName | ||
| defaultDBPort = database.DefaultPort | ||
|
|
||
| defaultSecretKey = "secret" | ||
| defaultAdminUser = "admin" | ||
| defaultAdminPass = "admin" | ||
|
|
||
| defaultLogsPath = services.DefaultTestLogsPath | ||
| ) | ||
|
|
||
| func NewAPICmd() *cobra.Command { | ||
| apiCmd := &cobra.Command{ | ||
| Use: apiCmdName, | ||
| Short: "Start the Knuu API server", | ||
| Long: "Start the API server to manage tests, tokens, and users.", | ||
| RunE: runAPIServer, | ||
| } | ||
|
|
||
| apiCmd.Flags().IntP(flagPort, "p", defaultPort, "Port to run the API server on") | ||
| apiCmd.Flags().StringP(flagAPILogLevel, "l", defaultLogLevel, "Log level: debug | release | test") | ||
|
|
||
| apiCmd.Flags().StringP(flagDBHost, "d", defaultDBHost, "Postgres database host") | ||
| apiCmd.Flags().StringP(flagDBUser, "", defaultDBUser, "Postgres database user") | ||
| apiCmd.Flags().StringP(flagDBPassword, "", defaultDBPassword, "Postgres database password") | ||
| apiCmd.Flags().StringP(flagDBName, "", defaultDBName, "Postgres database name") | ||
| apiCmd.Flags().IntP(flagDBPort, "", defaultDBPort, "Postgres database port") | ||
|
|
||
| apiCmd.Flags().StringP(flagSecretKey, "", defaultSecretKey, "JWT secret key") | ||
| apiCmd.Flags().StringP(flagAdminUser, "", defaultAdminUser, "Admin username") | ||
| apiCmd.Flags().StringP(flagAdminPass, "", defaultAdminPass, "Admin password") | ||
|
|
||
| apiCmd.Flags().StringP(flagTestsLogsPath, "", defaultLogsPath, "Directory to store logs of the tests") | ||
|
|
||
| return apiCmd | ||
| } | ||
|
|
||
| func runAPIServer(cmd *cobra.Command, args []string) error { | ||
| dbOpts, err := getDBOptions(cmd.Flags()) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get database options: %v", err) | ||
| } | ||
|
|
||
| db, err := database.New(dbOpts) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to connect to database: %v", err) | ||
| } | ||
|
|
||
| apiOpts, err := getAPIOptions(cmd.Flags()) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get API options: %v", err) | ||
| } | ||
|
|
||
| apiServer, err := api.New(context.Background(), db, apiOpts) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create API server: %v", err) | ||
| } | ||
|
|
||
| return apiServer.Start() | ||
| } | ||
mojtaba-esk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| func getDBOptions(flags *pflag.FlagSet) (database.Options, error) { | ||
| dbHost, err := flags.GetString(flagDBHost) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get database host: %v", err) | ||
| } | ||
|
|
||
| dbUser, err := flags.GetString(flagDBUser) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get database user: %v", err) | ||
| } | ||
|
|
||
| dbPassword, err := flags.GetString(flagDBPassword) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get database password: %v", err) | ||
| } | ||
|
|
||
| dbName, err := flags.GetString(flagDBName) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get database name: %v", err) | ||
| } | ||
|
|
||
| dbPort, err := flags.GetInt(flagDBPort) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get database port: %v", err) | ||
| } | ||
|
|
||
| apiLogLevel, err := flags.GetString(flagAPILogLevel) | ||
| if err != nil { | ||
| return database.Options{}, fmt.Errorf("failed to get API log level: %v", err) | ||
| } | ||
|
|
||
| var dbLogLevel logger.LogLevel | ||
| switch apiLogLevel { | ||
| case gin.DebugMode: | ||
| dbLogLevel = logger.Info | ||
| case gin.ReleaseMode: | ||
| dbLogLevel = logger.Error | ||
| case gin.TestMode: | ||
| dbLogLevel = logger.Info | ||
| } | ||
|
|
||
| return database.Options{ | ||
| Host: dbHost, | ||
| User: dbUser, | ||
| Password: dbPassword, | ||
| DBName: dbName, | ||
| Port: dbPort, | ||
| LogLevel: dbLogLevel, | ||
| }, nil | ||
| } | ||
|
|
||
| func getAPIOptions(flags *pflag.FlagSet) (api.Options, error) { | ||
| port, err := flags.GetInt(flagPort) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get port: %v", err) | ||
| } | ||
|
|
||
| apiLogLevel, err := flags.GetString(flagAPILogLevel) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get log level: %v", err) | ||
| } | ||
|
|
||
| secretKey, err := flags.GetString(flagSecretKey) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get secret key: %v", err) | ||
| } | ||
|
|
||
| adminUser, err := flags.GetString(flagAdminUser) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get admin user: %v", err) | ||
| } | ||
|
|
||
| adminPass, err := flags.GetString(flagAdminPass) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get admin password: %v", err) | ||
| } | ||
|
|
||
| testsLogsPath, err := flags.GetString(flagTestsLogsPath) | ||
| if err != nil { | ||
| return api.Options{}, fmt.Errorf("failed to get tests logs path: %v", err) | ||
| } | ||
|
|
||
| logger := logrus.New() | ||
| logger.SetFormatter(&logrus.JSONFormatter{}) | ||
|
|
||
| switch apiLogLevel { | ||
| case gin.DebugMode: | ||
| logger.SetLevel(logrus.DebugLevel) | ||
| case gin.ReleaseMode: | ||
| logger.SetLevel(logrus.ErrorLevel) | ||
| case gin.TestMode: | ||
| logger.SetLevel(logrus.InfoLevel) | ||
| } | ||
|
|
||
| return api.Options{ | ||
| Port: port, | ||
| APILogMode: apiLogLevel, // gin logger (HTTP request level) | ||
| SecretKey: secretKey, | ||
| AdminUser: adminUser, | ||
| AdminPass: adminPass, | ||
| Logger: logger, // handler (application level logger) | ||
| TestServiceOptions: services.TestServiceOptions{ | ||
| TestsLogsPath: testsLogsPath, // directory to store logs of each test | ||
| Logger: logger, | ||
| }, | ||
| }, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/celestiaorg/knuu/cmd/root" | ||
| ) | ||
|
|
||
| func main() { | ||
| if err := root.Execute(); err != nil { | ||
| logrus.WithError(err).Fatal("failed to execute command") | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package root | ||
|
|
||
| import ( | ||
| "github.com/celestiaorg/knuu/cmd/api" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var rootCmd = &cobra.Command{ | ||
| Use: "knuu", | ||
| Short: "Knuu CLI", | ||
| Long: "Knuu CLI provides commands to manage the Knuu API server and its operations.", | ||
| } | ||
|
|
||
| // Execute runs the root command. | ||
| func Execute() error { | ||
| return rootCmd.Execute() | ||
| } | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(api.NewAPICmd()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Security: Replace insecure default values.
The default values for sensitive data are insecure:
Consider:
Example implementation:
📝 Committable suggestion