Added the testify module for testing

.gitignore

@@ -1,21 +1,26 @@
-# ---> Rust
+# ---> Go
-# Generated by Cargo
+# If you prefer the allow list template instead of the deny list, see community template:
-# will have compiled files and executables
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-debug/
+#
-target/
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# Test binary, built with `go test -c`
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+*.test
-Cargo.lock
 
-# These are backup files generated by rustfmt
+# Output of the go coverage tool, specifically when used with LiteIDE
-**/*.rs.bk
+*.out
 
-# MSVC Windows builds of rustc generate these, which store debugging information
+# Dependency directories (remove the comment below to include it)
-*.pdb
+# vendor/
 
+# Go workspace file
+go.work
 
+# Compiled Go binary
+mcst
 
-# Added by cargo
-
-/target

.woodpecker.yml

@@ -1,17 +1,20 @@
 pipeline:
-  tests:
+  build_test:
-    image: rust:1.63
+    image: golang:1.16
     commands:
-      - "cargo test"
+      - go build
+
+  test:
+    image: golang:1.16
+    commands:
+      - go test -v ./...
 
   build_release:
-    image: rust:1.63
+    image: golang:1.16
     commands:
-      - "cargo install cargo-deb cargo-generate-rpm"
+      - go mod vendor
-      - "cargo build --release"
+      - GOOS=linux GOARCH=amd64 go build -ldflags "-X git.metaunix.net/BitGoblin/mcst/cmd.version=${CI_COMMIT_TAG}" -o "dist/mcst-linux-amd64-${CI_COMMIT_TAG}"
-      - "cargo deb"
+      - GOOS=windows GOARCH=amd64 go build -ldflags "-X git.metaunix.net/BitGoblin/mcst/cmd.version=${CI_COMMIT_TAG}" -o "dist/mcst-windows-amd64-${CI_COMMIT_TAG}.exe"
-      - "cargo generate-rpm"
-      - "mv target/release/mcst target/release/mcst-${CI_COMMIT_TAG}-linux-x86_64"
     when:
       event: tag
 
@@ -21,10 +24,8 @@ pipeline:
       api_key:
         from_secret: gitea_api_key
       base_url: https://git.metaunix.net
-      files:
-        - "target/release/*${CI_COMMIT_TAG}-linux-x86_64"
-        - "target/debian/mcst*.deb"
-        - "target/generate-rpm/mcst*.rpm"
       title: "${CI_COMMIT_TAG}"
+      files:
+        - dist/mcst-*
     when:
       event: tag

Cargo.toml

@@ -1,30 +0,0 @@
-[package]
-name = "mcst"
-description = "Bit Goblin Minecraft server management tool."
-version = "0.1.0"
-edition = "2021"
-readme = "README.md"
-license = "BSD 2-Clause"
-authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"]
-
-[dependencies]
-clap = { version = "3.2", features = ["derive"] }
-reqwest = { version = "0.11", features = ["blocking"] }
-shellexpand = "2.1"
-
-[package.metadata.deb]
-license-file = "LICENSE"
-depends = "openjdk-17-jre"
-section = "games"
-assets = [
-	["target/release/mcst", "usr/bin/mcst", "755"],
-	["README.md", "usr/share/doc/zealot/README", "644"]
-]
-
-[package.metadata.generate-rpm]
-assets = [
-  { source = "target/release/mcst", dest = "/usr/bin/mcst", mode = "755" },
-  { source = "README.md", dest = "/usr/share/doc/mcst/README", mode = "644"}
-]
-[package.metadata.generate-rpm.requires]
-java-17-openjdk = "*"

README.md

@@ -1,3 +1,18 @@
-# mcst
+# MCST
 
-Bit Goblin minecraft server tool
+Bit Goblin minecraft server management tool
+
+## Installation
+
+Build dependencies:
+* go
+* make
+
+To install dependencies on Ubuntu: `apt install golang make`
+To install dependencies on Red Hat/AlmaLinux: `dnf install go make`
+
+To install MCST as a system utility: `make build && sudo make install`
+
+## Uninstallation
+
+To uninstall MCST (if it was installed through make): `sudo make uninstall`

cmd/new.go

@@ -0,0 +1,92 @@
+package cmd
+
+import (
+	"fmt"
+	"io"
+	"log"
+	"net/http"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	"git.metaunix.net/BitGoblin/mcst/util"
+)
+
+var (
+	serverName string
+	minecraftVersion string
+)
+
+var newCmd = &cobra.Command{
+  Use:   "new",
+  Short: "Create a new Minecraft server instance.",
+  Long:  `Create a new Minecraft server instance.`,
+  Run: func(cmd *cobra.Command, args []string) {
+		log.Printf("Creating new server with name '%s', and version '%s'\n", serverName, minecraftVersion)
+
+		serverDirectoryPath := util.ResolveTilde(fmt.Sprintf("~/%s", serverName))
+
+		err := os.Mkdir(serverDirectoryPath, 0755)
+		if err != nil && !os.IsExist(err) {
+			log.Fatal(err)
+		}
+
+		var serverJarURL string = "https://piston-data.mojang.com/v1/objects/f69c284232d7c7580bd89a5a4931c3581eae1378/server.jar"
+		var serverFilePath string = fmt.Sprintf("%s/server_%s.jar", serverDirectoryPath, minecraftVersion)
+
+		log.Printf("Downloading %s to %s\n", serverJarURL, serverFilePath)
+		file, err := os.Create(serverFilePath)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    client := http.Client{
+			CheckRedirect: func(r *http.Request, via []*http.Request) error {
+				r.URL.Opaque = r.URL.Path
+				return nil
+			},
+    }
+
+    // Put content on file
+    resp, err := client.Get(serverJarURL)
+    if err != nil {
+        log.Fatal(err)
+    }
+    defer resp.Body.Close()
+
+    _, err = io.Copy(file, resp.Body)
+    defer file.Close()
+
+		// create the shell script to start the server
+		log.Printf("Creating start.sh shell script.\n")
+		var scriptFilePath string = fmt.Sprintf("%s/start.sh", serverDirectoryPath)
+		scriptFile, err := os.Create(scriptFilePath)
+		if err != nil {
+			log.Fatalf("Unable to open file: %v", err)
+		}
+		defer scriptFile.Close()
+
+		// add text to the file
+		_, err = scriptFile.WriteString(fmt.Sprintf("#!/bin/sh\n\ncd %s\njava -Xmx2048M -Xms2048M -jar server_%s.jar nogui", serverDirectoryPath, minecraftVersion))
+		if err != nil {
+			log.Fatalf("Unable to write data: %v", err)
+		}
+
+		// set permissions on the script
+		err = os.Chmod(scriptFilePath, 0755)
+		if err != nil {
+			log.Fatalf("Unable to change script permissions: %v", err)
+		}
+  },
+}
+
+func init() {
+	// bind flags to variables
+	newCmd.Flags().StringVarP(&serverName, "server-name", "n", "", "The name for your new server.")
+	newCmd.MarkFlagRequired("server-name")
+	newCmd.Flags().StringVarP(&minecraftVersion, "minecraft-version", "m", "", "Minecraft Java Edition server version to use.")
+	newCmd.MarkFlagRequired("minecraft-version")
+
+	// add this command to the command root
+  rootCmd.AddCommand(newCmd)
+}

cmd/root.go

@@ -0,0 +1,30 @@
+package cmd
+
+import (
+	"log"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+  version string
+)
+
+var rootCmd = &cobra.Command{
+  Use:   "mcst",
+  Short: "MCST is a tool to manage Minecraft Java edition servers.",
+  Long: `A flexible yet user-friendly tool to manage Minecraft Java edition server.
+		Source code available at https://git.metaunix.net/BitGoblin/mcst`,
+  Run: func(cmd *cobra.Command, args []string) {
+    log.Printf("This is a test.")
+  },
+  Version: version,
+}
+
+func Start() {
+  if err := rootCmd.Execute(); err != nil {
+    log.Println(err)
+    os.Exit(1)
+  }
+}

go.mod

@@ -0,0 +1,14 @@
+module git.metaunix.net/BitGoblin/mcst
+
+go 1.18
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/cobra v1.5.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/stretchr/objx v0.4.0 // indirect
+	github.com/stretchr/testify v1.8.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,24 @@
+github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
+github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
+github.com/spf13/cobra v1.5.0/go.mod h1:dWXEIy2H428czQCjInthrTRUg7yKbok+2Qi/yBIJoUM=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0 h1:M2gUjqZET1qApGOWNSnZ49BAIMX4F/1plDv3+l31EJ4=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

mcst.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	"git.metaunix.net/BitGoblin/mcst/cmd"
+)
+
+func main() {
+	cmd.Start()
+}

src/cmd/mod.rs

@@ -1,2 +0,0 @@
-pub mod new;
-pub mod start;

src/cmd/new.rs

@@ -1,37 +0,0 @@
-extern crate reqwest;
-
-use std::fs;
-use std::os::unix::fs::PermissionsExt;
-use std::io;
-use std::io::prelude::*;
-
-pub fn new_command(server_name: &str, minecraft_version: &str) -> Result<(), Box<dyn std::error::Error>> {
-  println!("Creating new server with name '{}' using version '{}'.", server_name, minecraft_version);
-
-  let home_path = shellexpand::tilde("~");
-  let server_directory_path = format!("{}/{}", home_path, server_name);
-  let server_file_path = format!("{}/server_{}.jar", server_directory_path, minecraft_version);
-
-  // create the server directory
-  println!("Creating server directory {}.", server_directory_path);
-  fs::create_dir(&server_directory_path)?;
-
-  // download the Minecraft server JAR file
-  let server_jar_url = "https://piston-data.mojang.com/v1/objects/f69c284232d7c7580bd89a5a4931c3581eae1378/server.jar";
-  println!("Downloading {} to {}.", server_jar_url, server_file_path);
-  let mut resp = reqwest::blocking::get(server_jar_url)?;
-  let mut out = fs::File::create(server_file_path)?;
-  io::copy(&mut resp, &mut out)?;
-
-  // create the start.sh shell script
-  let script_file_path = format!("{}/start.sh", server_directory_path);
-  println!("Creating start.sh script.");
-  let mut script_file = fs::File::create(script_file_path)?;
-  let script_file_contents = format!("#!/bin/sh\n\ncd {}\njava -Xmx2048M -Xms2048M -jar server_{}.jar nogui", server_directory_path, minecraft_version);
-  script_file.write_all(script_file_contents.as_bytes())?;
-  // set the file permissions on the start.sh script
-  script_file.set_permissions(fs::Permissions::from_mode(0o755))?;
-
-  // return empty result to signify everything is okay
-  Ok(())
-}

src/cmd/start.rs

@@ -1,27 +0,0 @@
-use std::process::{Command, Stdio};
-
-pub fn start_command(server_name: &str) -> Result<(), Box<dyn std::error::Error>> {
-  println!("Starting server {}.", server_name);
-
-  // set up our path variables
-  let home_path = shellexpand::tilde("~");
-  let server_directory_path = format!("{}/{}", home_path, server_name);
-  let script_file_path = format!("{}/start.sh", server_directory_path);
-  let eula_file_path = format!("{}/eula.txt", server_directory_path);
-
-  // check if eula.txt exists - if it doesn't then warn the user they'll need to accept it and possibly modify server settings
-  if !std::path::Path::new(&eula_file_path).exists() {
-    println!("The eula.txt does not exist - you will need to accept the EULA located at {} by changing 'false' to 'true'.", eula_file_path);
-    println!("This appears to be a new server instance. Don't forget to modify server.properties!");
-  }
-
-  // run the start command
-  Command::new(script_file_path)
-    .stdin(Stdio::null())
-    .stdout(Stdio::null())
-    .stderr(Stdio::null())
-    .spawn()?;
-
-  // return okay signal
-  Ok(())
-}

src/main.rs

@@ -1,45 +0,0 @@
-mod cmd;
-
-use clap::{Parser, Subcommand};
-
-#[derive(Parser)]
-#[clap(name = "Minecraft server management tool", author, version, about = "Bit Goblin's Minecraft server management tool.", long_about = None)]
-#[clap(propagate_version = true)]
-struct Cli {
-  #[clap(subcommand)]
-  command: Commands,
-}
-
-#[derive(Subcommand)]
-enum Commands {
-  // new server subcommand
-  #[clap(name = "new", about = "Create a new Minecraft java edition server instance.")]
-  New {
-    #[clap(short = 'n', long, required = true, help = "[REQUIRED] The name for your new server.")]
-    server_name: String,
-    #[clap(short = 'm', long, required = true, help = "[REQUIRED] Minecraft Java Edition server version to use.")]
-    minecraft_version: String,
-  },
-
-  #[clap(name = "start", about = "Start a Minecraft java edition server instance.")]
-  Start {
-    #[clap(short = 'n', long, required = true, help = "[REQUIRED] The name of your Minecraft server instance.")]
-    server_name: String,
-  }
-}
-
-fn main() {
-  // start the Clap CLI
-  let cli = Cli::parse();
-
-  // map subcommands back to the main command
-  let res = match &cli.command {
-    Commands::New { server_name, minecraft_version } => cmd::new::new_command(&server_name, &minecraft_version),
-    Commands::Start { server_name } => cmd::start::start_command(&server_name),
-  };
-
-  match res {
-    Ok(_) => {},
-    Err(e) => panic!("MCST ran into an error: {}", e),
-  };
-}

util/env.go

@@ -0,0 +1,23 @@
+package util
+
+import (
+  "path/filepath"
+  "os/user"
+  "strings"
+)
+
+func ResolveTilde(path string) string {
+  usr, _ := user.Current()
+  dir := usr.HomeDir
+
+  if path == "~" {
+    // In case of "~", which won't be caught by the "else if"
+    path = dir
+  } else if strings.HasPrefix(path, "~/") {
+    // Use strings.HasPrefix so we don't match paths like
+    // "/something/~/something/"
+    path = filepath.Join(dir, path[2:])
+  }
+
+  return path
+}

util/env_test.go

@@ -0,0 +1,29 @@
+package util
+
+import (
+	"testing"
+	"github.com/stretchr/testify/assert"
+  "github.com/stretchr/testify/suite"
+)
+
+// define our test suite struct
+type EnvTestSuite struct {
+	suite.Suite
+}
+
+// the tilde should expand to user's home directory
+func (s *EnvTestSuite) TestResolveTilde() {
+	resolvedPath := ResolveTilde("~")
+	assert.NotEqual(s.T(), resolvedPath, "~")
+}
+
+// ensure the tilde + relative path gets expanded fully
+func (s *EnvTestSuite) TestResolveTildePath() {
+	resolvedPath := ResolveTilde("~/test")
+	assert.NotEqual(s.T(), resolvedPath, "~/test")
+}
+
+// this is needed to run the test suite
+func TestEnvTestSuite(t *testing.T) {
+	suite.Run(t, new(EnvTestSuite))
+}