init commit

Author: talgat-ruby

.github/workflows/go_pr.yml

@@ -0,0 +1,20 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go PR
+
+on:
+  pull_request:
+    branches-ignore:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.22'
+    - name: Test
+      run: SKIPTEST=optional go test -v -bench=. -race ./...

.gitignore

@@ -0,0 +1,27 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+
+.idea
+.DS_Store*
+
+# Students
+students.txt

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Talgat Sarybaev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+# exercises-go
+
+This is exercises repo.
+
+## Prerequisites
+
+You will need:
+
+- [git](https://git-scm.com/)
+- [go](https://go.dev/)
+
+## Start
+
+1. Fork repo.
+
+![fork](./assets/fork.png "Fork button")
+
+2. Clone forked repo. Use ssh because you will need to push.
+
+3. Solve problems and test if they are valid.
+
+```shell
+go test -v -bench=. -race ./...
+```
+
+## Update
+
+First need setup remote repo for update. You need to do that **once**:
+
+```shell
+git remote add upstream [email protected]:talgat-ruby/exercises-go.git
+git remote set-url --push upstream DISABLE
+```
+
+Now any time you need to update you can do:
+
+```shell
+git pull upstream main
+```
+
+## Test
+
+In order to run specific exercise (for example `exercise2`):
+
+```shell
+go test -v -bench -race ./exercise2/...
+```
+
+Or specific problem (for example `exercise3/problem5`):
+
+```shell
+go test -v -bench=. -race ./exercise3/problem5/...
+```
+
+Skip optional tests:
+
+```shell
+SKIPTEST=optional go test -v -bench=. -race ./exercise1/...
+```
+
+## PR
+
+create PR from your repo to this one from branch `{firstname}-{lastname}` for example `talgat-saribayev`.

assets/fork.png

@@ -0,0 +1,3 @@
+module github.com/talgat-ruby/exercises-go
+
+go 1.22.3

go.mod

@@ -0,0 +1,4 @@
+package main
+
+const cmdNameCreateBranches = "create-branches"
+const cmdNameMergeMain = "merge-main"

internal/cli/studentsBranch/constants.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	_ "embed"
+	"flag"
+	"fmt"
+	"os"
+)
+
+//go:embed students.txt
+var studentsData string
+
+func main() {
+	cmdCreateBranches := newSubcmdCreateBranches()
+	cmdMergeMain := newSubcmdMergeMain()
+
+	// Verify that a subcommand has been provided
+	// os.Arg[0] is the main command
+	// os.Arg[1] will be the subcommand
+	if len(os.Args) < 2 {
+		fmt.Printf(
+			"one of subcommands: %v is required\n",
+			[]string{
+				cmdCreateBranches.getCmdName(),
+				cmdMergeMain.getCmdName(),
+			},
+		)
+		os.Exit(1)
+	}
+
+	// Switch on the subcommand
+	// Parse the flags for appropriate FlagSet
+	// FlagSet.Parse() requires a set of arguments to parse as input
+	// os.Args[2:] will be all arguments starting after the subcommand at os.Args[1]
+	switch os.Args[1] {
+	case cmdCreateBranches.getCmdName():
+		if err := cmdCreateBranches.parse(os.Args[2:]); err != nil {
+			fmt.Printf("error in cmd %s: %+v", cmdCreateBranches.getCmdName(), err)
+			cmdCreateBranches.printDefaults()
+			os.Exit(1)
+		}
+	case cmdMergeMain.getCmdName():
+		if err := cmdMergeMain.parse(os.Args[2:]); err != nil {
+			fmt.Printf("error in cmd %s: %+v", cmdMergeMain.getCmdName(), err)
+			cmdMergeMain.printDefaults()
+			os.Exit(1)
+		}
+	default:
+		flag.PrintDefaults()
+		os.Exit(1)
+	}
+}

internal/cli/studentsBranch/main.go

@@ -0,0 +1,7 @@
+package main
+
+type subcmd interface {
+	getCmdName() string
+	printDefaults()
+	parse([]string) error
+}

internal/cli/studentsBranch/subcmd.go

@@ -0,0 +1,62 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"sort"
+	"strings"
+)
+
+type subcmdCreateBranches struct {
+	cmd      *flag.FlagSet
+	students []string
+}
+
+func newSubcmdCreateBranches() *subcmdCreateBranches {
+	cmd := flag.NewFlagSet(cmdNameCreateBranches, flag.ExitOnError)
+
+	students := strings.Split(strings.TrimSpace(studentsData), "\n")
+	sort.Strings(students)
+
+	return &subcmdCreateBranches{
+		cmd:      cmd,
+		students: students,
+	}
+}
+
+func (s *subcmdCreateBranches) getCmdName() string {
+	return s.cmd.Name()
+}
+
+func (s *subcmdCreateBranches) printDefaults() {
+	s.cmd.PrintDefaults()
+}
+
+func (s *subcmdCreateBranches) parse(args []string) error {
+	if err := s.cmd.Parse(args); err != nil {
+		return err
+	}
+
+	// Check which subcommand was Parsed using the FlagSet.Parsed() function. Handle each case accordingly.
+	// FlagSet.Parse() will evaluate to false if no flags were parsed (i.e. the user did not provide any flags)
+	if !s.cmd.Parsed() {
+		return fmt.Errorf("please provide correct arguments to %s command", s.cmd.Name())
+	}
+
+	if err := switchToBranch("main"); err != nil {
+		return fmt.Errorf("could not switch to main branch: %w", err)
+	}
+
+	for _, student := range s.students {
+		if err := createRemoteBranch(student); err != nil {
+			return fmt.Errorf("could not create remote branch: %w", err)
+		}
+		fmt.Printf("created remote branch %s\n", student)
+	}
+
+	if err := switchToBranch("main"); err != nil {
+		return fmt.Errorf("could not switch to main branch: %w", err)
+	}
+
+	return nil
+}

internal/cli/studentsBranch/subcmdCreateBranches.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"sort"
+	"strings"
+)
+
+type subcmdMergeMain struct {
+	cmd      *flag.FlagSet
+	students []string
+}
+
+func newSubcmdMergeMain() *subcmdMergeMain {
+	cmd := flag.NewFlagSet(cmdNameMergeMain, flag.ExitOnError)
+
+	students := strings.Split(strings.TrimSpace(studentsData), "\n")
+	sort.Strings(students)
+
+	return &subcmdMergeMain{
+		cmd:      cmd,
+		students: students,
+	}
+}
+
+func (s *subcmdMergeMain) getCmdName() string {
+	return s.cmd.Name()
+}
+
+func (s *subcmdMergeMain) printDefaults() {
+	s.cmd.PrintDefaults()
+}
+
+func (s *subcmdMergeMain) parse(args []string) error {
+	if err := s.cmd.Parse(args); err != nil {
+		return err
+	}
+
+	// Check which subcommand was Parsed using the FlagSet.Parsed() function. Handle each case accordingly.
+	// FlagSet.Parse() will evaluate to false if no flags were parsed (i.e. the user did not provide any flags)
+	if !s.cmd.Parsed() {
+		return fmt.Errorf("please provide correct arguments to %s command", s.cmd.Name())
+	}
+
+	if err := switchToBranch("main"); err != nil {
+		return fmt.Errorf("could not switch to main branch: %w", err)
+	}
+
+	for _, student := range s.students {
+		if err := switchToBranch(student); err != nil {
+			return fmt.Errorf("could not switch to %s branch: %w", student, err)
+		}
+		if err := mergeFromLocal("main"); err != nil {
+			return fmt.Errorf("could not merge main to %s branch: %w", student, err)
+		}
+		if err := pushRemoteBranch(student); err != nil {
+			return fmt.Errorf("could not push to %s branch: %w", student, err)
+		}
+		fmt.Printf("merged main to %s\n", student)
+	}
+
+	if err := switchToBranch("main"); err != nil {
+		return fmt.Errorf("could not switch to main branch: %w", err)
+	}
+
+	return nil
+}

internal/cli/studentsBranch/subcmdMergeMain.go

@@ -0,0 +1,37 @@
+package main
+
+import (
+	"fmt"
+	"os/exec"
+)
+
+func createRemoteBranch(branch string) error {
+	if err := switchToBranch(branch); err != nil {
+		return fmt.Errorf("could not switch to branch %s: %w", branch, err)
+	}
+
+	if err := pushRemoteBranch(branch); err != nil {
+		return fmt.Errorf("could not push remote branch %s: %w", branch, err)
+	}
+
+	if err := switchToBranch("main"); err != nil {
+		return fmt.Errorf("could not switch to main branch: %w", err)
+	}
+
+	return nil
+}
+
+func switchToBranch(branch string) error {
+	cmd := exec.Command("git", "switch", "-C", branch)
+	return cmd.Run()
+}
+
+func mergeFromLocal(branch string) error {
+	cmd := exec.Command("git", "merge", branch)
+	return cmd.Run()
+}
+
+func pushRemoteBranch(branch string) error {
+	cmd := exec.Command("git", "push", "--set-upstream", "origin", branch)
+	return cmd.Run()
+}

internal/cli/studentsBranch/utils.go

@@ -0,0 +1 @@
+package main

main.go

@@ -0,0 +1,12 @@
+package util
+
+import (
+	"os"
+	"testing"
+)
+
+func SkipTestOptional(t *testing.T) {
+	if os.Getenv("SKIPTEST") == "optional" {
+		t.Skip("Skipping testing in CI environment")
+	}
+}