Merge pull request #65 from Phillezi/tests

Added some tests and docs

Author: Phillezi

.github/workflows/go.yml

@@ -7,6 +7,7 @@ on:
       - README.md
       - .gitignore
       - .github/**
+      - docs/*
       - LICENSE
 
 jobs:

Makefile

@@ -6,7 +6,7 @@ BUILDTIMESTAMP=$(shell date -u +%Y%m%d%H%M%S)
 EXT=$(if $(filter windows,$(GOOS)),.exe,)
 
 # Targets
-.PHONY: all build run test release install all-platforms clean lint
+.PHONY: all build run test release install all-platforms clean lint docs
 
 all: build
 
@@ -54,3 +54,6 @@ clean:
 
 lint:
 	@./scripts/util/check-lint.sh
+
+docs:
+	@go run ./cmd/docs

cmd/cli_build.go

@@ -11,6 +11,12 @@ import (
 var buildCmd = &cobra.Command{
 	Use:   "build",
 	Short: "Build and push to the deployment specified in .kthcloud/DEPLOYMENT",
+	Long: `
+Allows you to build and push your custom deployment locally using docker.
+
+It uses the file ".kthcloud/DEPLOYMENT" to figure out which deployment your cwd maps to. This file contains the UUID of the deployment.
+
+[!NOTE]: Requires you to have docker with buildx installed.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := build.New(build.CommandOpts{
 			Client: options.DefaultClient(),

cmd/cli_cicd.go

@@ -10,6 +10,8 @@ import (
 var cicdCmd = &cobra.Command{
 	Use:   "cicd",
 	Short: "Generate CICD for gh repo",
+	Long: `
+This command allows you to setup cicd for your git repo, it creates a custom deployments and adds a workflow for building and pushing to the kthcloud registry on push / merge to main ".github/workflows/".`,
 	Run: func(cmd *cobra.Command, args []string) {
 		save, err := cmd.Flags().GetBool("save-secrets")
 		if err != nil {

cmd/cli_compose.go

@@ -19,11 +19,22 @@ import (
 var composeCmd = &cobra.Command{
 	Use:   "compose",
 	Short: "Deploy and manage Docker Compose projects on the cloud",
+	Long: `
+Compose lets you describe multiple deployments in yaml files similary to how you would do it with docker compose.
+
+The services described in the yaml files can be brought up on the cloud, you can bring them down, stop them or see logs from them.`,
 }
 
 var composeParseCmd = &cobra.Command{
 	Use:   "parse",
 	Short: "Parse a docker-compose.yaml or docker-compose.yml file",
+	Long: `
+A simple command that parses a compose file into kthclouds create deployment json format.
+
+The compose file can be specified with the --file flag.
+
+Adding the --json flag will return pure json as response.`,
+	Example: "kthcloud compose parse",
 	Run: func(cmd *cobra.Command, args []string) {
 		json, err := cmd.Flags().GetBool("json")
 		if err != nil {
@@ -48,6 +59,20 @@ var composeParseCmd = &cobra.Command{
 var composeUpCmd = &cobra.Command{
 	Use:   "up",
 	Short: "Deploy compose configuration to cloud",
+	Long: `
+This command allows you to bring up a local compose definition to kthcloud.
+
+It will automatically detect if you have custom deployments in your config that needs to be built.
+[!NOTE]: To keep track of custom deployments a file in "./.kthcloud/DEPLOYMENT" is made (relative to the build context of the service). This file contains the UUID of the deployment that the service maps to.
+
+To rebuild services you can apply the --build flag to rebuild all services, or specify the ones you want to rebuild.
+
+Volumes can be defined and managed, but it is done in a hacky way. Since the storage (filebrowser) instance that gets deployed for your user is behind a oauth2 proxy that only uses cookies for authentication. The current solution is as mention very hacky as it will try to scrape your browser for these cookies to authenticate. This only works on Linux and MacOS, but it can be unreliable since browser companies dont want you to be able too scrape stuff like this.
+
+Default behaviour of this command will after creating all the deployments setup SSE log streams from all created deployments to your terminal. This can be skipped by adding the -d flag.`,
+	Example: `kthcloud compose up \
+	--file ./somesubdir/example.compose.yml \
+	--try-volumes`,
 	Run: func(cmd *cobra.Command, args []string) {
 		detached, _ := cmd.Flags().GetBool("detached")
 		tryToCreateVolumes, _ := cmd.Flags().GetBool("try-volumes")
@@ -82,6 +107,9 @@ var composeUpCmd = &cobra.Command{
 var composeDownCmd = &cobra.Command{
 	Use:   "down",
 	Short: "Bring down compose configuration to cloud",
+	Long: `
+This command will bring down all services specified in the compose file. By default custom deployments wont be brought down, this can be changed with the -a flag.`,
+	Example: "kthcloud compose --file ./compose.yaml down -a",
 	Run: func(cmd *cobra.Command, args []string) {
 		all, err := cmd.Flags().GetBool("all")
 		if err != nil {
@@ -105,6 +133,10 @@ var composeDownCmd = &cobra.Command{
 var composeStopCmd = &cobra.Command{
 	Use:   "stop",
 	Short: "Stop compose configuration to cloud",
+	Long: `
+This command will disable all services specified in the compose file. This is done my setting their replicas to zero.
+
+[!NOTE]: At the time of writing this there is currently a but that when trying to re-enable these services later requires you to change more than just setting replicas back to 1 or whatever value it was before.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		compose, err := parser.GetCompose()
 		if err != nil {
@@ -123,6 +155,8 @@ var composeStopCmd = &cobra.Command{
 var composeLogsCmd = &cobra.Command{
 	Use:   "logs",
 	Short: "Get logs from deployments in the compose file",
+	Long: `
+This command allows you to get all logs from the services specified in the compose file.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		compose, err := parser.GetCompose()
 		if err != nil {

cmd/cli_login.go

@@ -9,6 +9,11 @@ import (
 var loginCmd = &cobra.Command{
 	Use:   "login",
 	Short: "Log in to kthcloud using Keycloak and retrieve the authentication token",
+	Long: `
+Lets you log in to kthcloud by opening a local server on ":3000" and opening your browser to kthclouds keycloak server with the redirect uri set to the local http server so the accesstoken can be retrieved.
+
+On Linux make sure you have "xdg-open" (should be included by default in most distros) and a browser for this to work.`,
+	Example: "kthcloud login",
 	Run: func(cmd *cobra.Command, args []string) {
 		c := options.DefaultClient()
 		_, err := c.Login()

cmd/cli_logout.go

@@ -9,6 +9,9 @@ import (
 var logoutCmd = &cobra.Command{
 	Use:   "logout",
 	Short: "Logout from kthcloud",
+	Long: `
+Removes your current session.`,
+	Example: "kthcloud logout",
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := options.DefaultClient().Auth().Logout(); err != nil {
 			logrus.Errorln(err)

cmd/cli_ps.go

@@ -12,6 +12,11 @@ import (
 var psCmd = &cobra.Command{
 	Use:   "ps",
 	Short: "List deployments",
+	Long: `
+This command lets you list your deploymentss that are running, adding the -a or --all flag will list all deploymentss and wont filter to only the ones with resourceRunning status.
+
+For VMs you can use the "kthcloud vm ps" command instead.`,
+	Example: "kthcloud ps -a",
 	Run: func(cmd *cobra.Command, args []string) {
 		all, err := cmd.Flags().GetBool("all")
 		if err != nil {

cmd/cli_root.go

@@ -37,8 +37,12 @@ var rootCmd = &cobra.Command{
 }
 
 var versionCmd = &cobra.Command{
-	Use:   "version",
-	Short: "See the version of the binary",
+	Use:     "version",
+	Aliases: []string{"v"},
+	Short:   "See the version of the binary",
+	Long: `
+Prints out the version of the binary that you are running. The version uses the build timestamp but in the future this might change to semantic versioning since it is more supported with gos versioning of packages.`,
+	Example: "kthcloud version",
 	Run: func(cmd *cobra.Command, args []string) {
 		fmt.Println("version: " + viper.GetString("release"))
 	},
@@ -47,6 +51,9 @@ var versionCmd = &cobra.Command{
 var whoamiCmd = &cobra.Command{
 	Use:   "whoami",
 	Short: "See who you are",
+	Long: `
+Prints out your user information from your current session, if not logged in you will get "I dont know...".`,
+	Example: "kthcloud whoami",
 	Run: func(cmd *cobra.Command, args []string) {
 		c := options.DefaultClient()
 		if !c.HasValidSession() {

cmd/cli_run.go

@@ -12,7 +12,12 @@ import (
 var runCmd = &cobra.Command{
 	Use:   "run",
 	Short: "Run a container",
-	Args:  cobra.MinimumNArgs(1),
+	Long: `
+This command allows you to start up containers similarly to dockers run command. It has options to remove it when you exit (with ctrl + c), get logs and more.
+
+Ports can be added with the -p or --p flag, you can just like docker add multiple ports, but in this case only the first port is used for the ingress (the one you can reach from outside the cluster) the rest of the ports are added as "internal" ports and are only exposed internally to the cluster.`,
+	Example: "kthcloud run --rm -it -p 80 nginx:latest",
+	Args:    cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		i, err := cmd.Flags().GetBool("interactive")
 		if err != nil {