Oleg Fedorovich

.gitignore

@@ -1,12 +1,4 @@
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, build with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
+client/client
+server/server
 *.out
+*.json

Dockerfile

@@ -0,0 +1,38 @@
+FROM golang:1.11-alpine3.8
+
+EXPOSE 9090
+
+# Preparation stage.
+RUN apk add build-base
+
+RUN apk update && apk upgrade && apk add git
+
+RUN go get golang.org/x/tools/cmd/goimports
+
+RUN go get -u golang.org/x/lint/golint
+
+RUN go get github.com/stretchr/testify
+
+ADD . /go/src/NonRelDB/
+
+# Check stage.
+WORKDIR /go/src/NonRelDB
+
+RUN go vet ./...
+
+RUN goimports ./
+
+RUN golint ./...
+
+# Build stage.
+WORKDIR /go/src/NonRelDB/server
+
+RUN go build server.go 
+
+WORKDIR /go/src/NonRelDB/client
+
+RUN go build client.go 
+
+# Entrypoint bind.
+ENTRYPOINT [ "/go/src/NonRelDB/server/server" ]
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 777777miSSU7777777
+
+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.

Makefile

@@ -0,0 +1,37 @@
+CURRENT_DIR = $(shell pwd)
+
+check:
+	go vet ./...
+
+	goimports ./
+
+	golint ./...
+
+clean-binaries:
+	rm server/server && rm client/client
+
+build-server:
+	go build -o server/server $(CURRENT_DIR)/server/server.go
+
+build-client:
+	go build -o client/client $(CURRENT_DIR)/client/client.go
+
+clean:
+	sudo docker system prune
+
+build: clean
+	sudo docker build -t "nonreldb" .
+
+run: clean
+	sudo docker run -d --net=host nonreldb
+
+test: 
+	echo "Running unit & integration tests"
+
+	go test ./... -coverprofile coverage.out
+
+	go tool cover -html=coverage.out
+
+
+
+

README.md

@@ -0,0 +1,96 @@
+## NonRelDB
+
+NonRelDB is an in-memory database that persists on disk. The data model is key-value. Written on pure golang.
+
+## Installation
+First of all you need to install [git](https://git-scm.com/) and [docker](https://www.docker.com/)
+Then you need to clone repository on your pc from github
+
+    git clone https://github.com/777777miSSU7777777/NonRelDB.git
+
+In cloned repository you will find **Makefile** with following targets:
+
+ - **build-server** - builds server's executable binary file.
+ - **build-client** - builds client's executable binary file.
+ - **clean-binaries** - removes server's & client's binaries on local machine.
+ - **build** - copies server's & client's & dependencies src, adds go vet, goimports and golint. Runs checks and if no errors were occured, builds server's & client's binaries. Entrypoint is server with default configuration.
+ - **clean** - cleans docker's unused containers, networks, volumes and dangling images.
+ - **check** - runs subsequently go vet, goimports and golint on the project. Fails if any error occurs.
+ - **test** - runs unit & integration tests. Fails if any test don't pass.
+ - **run** - runs built docker container in detached mode.
+## Usage
+### Server's flags
+ - **-host -h** - defines host ip (default is 127.0.0.1)
+ - **-port -p** - defines host port (default is 9090)
+ - **-mode -m** - defines storage location (default is "memory"). Possible options are "memory" and "disk".
+ - **-location -l** - defines storage location on disk (default is "storage.json").
+### Client's flags
+ - **-host -h** - defines host ip (default is 127.0.0.1)
+ - **-port -p** - defines host port (default is 9090)
+ - **--dump** - requests full database dump in json format on stdout.  
+ Usage example
+
+    ./client --dump > dump.json
+
+ - **--restore** - restores database from stdin.  
+ Usage example 
+
+
+    ./client --restore < dump.json
+
+### Commands
+Commands can be entered only in one register (**GET** and **get** but not **Get**).
+
+ **List of supported commands**
+ - **GET** - returns the value if existing, otherwise message "Value with this key not found".  
+ Example
+
+
+    GET 123
+
+
+ - **SET** - set the value if existing, otherwise creates new. Also returns message "Value has changed".  
+ **Value must be in double quotes.*  
+ Example
+
+
+    SET 123 "123"
+
+
+ - **DEL** - deletes value from storage and returns it's value if existing, otherwise message "Value with this key not found".  
+ Example
+
+
+    DEL 123
+
+- **KEYS** - returns all keys matching to entered regexp pattern, otherwise message "Keys with this pattern not found" or "Pattern is incorrect".  
+**Regex pattern must be in double quotes.*  
+Example
+
+    KEYS "/*"
+
+- **SUBSCRIBE** - subscribes the client on specified channel.  
+Example 
+
+    SUBSCRIBE redis
+
+- **UNSUBSCRIBE** - unsubscribes the client from specified channel.  
+**Cannot use from client because after subscribe client turns into listening state.*  
+Example
+
+    UNSUBSCRIBE redis
+
+- **PUBLISH** - sends the message to specified channel.  
+*\*Message must be in double quotes.*   
+Example
+
+    PUBLISH redis "Hello world"
+
+##   Project requirements
+
+ - There no verbose mode and flag because logger any way logs full user's request.
+ - Not implemented TAB completion of the commands in cli.
+
+ ## Notice
+ - Server & client will crash with non-existing flag's values.
+ - Not implented -help flag.

client/client.go

@@ -0,0 +1,63 @@
+package main
+
+import (
+	"NonRelDB/client/handler"
+	"NonRelDB/log"
+	"bufio"
+	"flag"
+	"fmt"
+	"net"
+	"os"
+)
+
+var host string
+var port string
+var dump bool
+var restore bool
+var location string
+
+func init() {
+	flag.StringVar(&host, "host", "127.0.0.1", "Defines host ip")
+	flag.StringVar(&host, "h", "127.0.0.1", "Defines host ip")
+	flag.StringVar(&port, "port", "9090", "Defines host port")
+	flag.StringVar(&port, "p", "9090", "Defines host port")
+	flag.BoolVar(&dump, "dump", false, "Requests db dump in json format from server")
+	flag.BoolVar(&restore, "restore", false, "Restores db from dumped file")
+	flag.Parse()
+}
+
+// main entry point for client.
+func main() {
+	c, err := net.Dial("tcp", host+":"+port)
+	defer c.Close()
+
+	if err != nil {
+		log.Error.Panicln(err.Error())
+	}
+
+	if dump {
+		fmt.Fprintf(c, "dump\n")
+		dbDump, err := bufio.NewReader(c).ReadString('\n')
+
+		if err != nil {
+			log.Error.Panicln(err.Error())
+		}
+
+		fmt.Println(dbDump)
+		return
+	}
+
+	if restore {
+		fmt.Fprintf(c, "restore\n")
+		dbRestore, err := bufio.NewReader(os.Stdin).ReadString('\n')
+
+		if err != nil {
+			log.Error.Panicln(err.Error())
+		}
+
+		fmt.Fprintf(c, dbRestore)
+		return
+	}
+
+	handler.HandleConnection(c)
+}

client/handler/handle_connection.go

@@ -0,0 +1,65 @@
+package handler
+
+import (
+	"NonRelDB/log"
+	"NonRelDB/util/regex"
+	"bufio"
+	"fmt"
+	"net"
+	"os"
+	"strings"
+)
+
+// SendRequest sends request to specified connection.
+func SendRequest(req string, c net.Conn) {
+	fmt.Fprintf(c, req+"\n")
+}
+
+// HandleConnection handling communication with server.
+func HandleConnection(c net.Conn) {
+	consoleReader := bufio.NewReader(os.Stdin)
+	netReader := bufio.NewReader(c)
+	for {
+		fmt.Printf("%s> ", c.RemoteAddr().String())
+		req, err := consoleReader.ReadString('\n')
+		req = strings.Trim(req, "\n")
+
+		if err != nil {
+			log.Error.Panicln(err.Error())
+		}
+
+		if regex.QueryReg.MatchString(req) {
+			SendRequest(req, c)
+			resp, err := netReader.ReadString('\n')
+
+			if err != nil {
+				log.Error.Panicln(err.Error())
+			}
+
+			fmt.Println(resp)
+
+		} else if regex.ExitReg.MatchString(req) {
+			fmt.Println("Good bye")
+			SendRequest(req, c)
+			return
+
+		} else if regex.TopicReg.MatchString(req) {
+			reqParts := strings.Split(req, " ")
+
+			if len(reqParts) == 2 {
+				if strings.ToLower(reqParts[0]) == "subscribe" {
+					SendRequest(req, c)
+					HandleTopic(c, *netReader, reqParts[1])
+				}
+			} else if len(reqParts) >= 3 {
+				if strings.ToLower(reqParts[0]) == "publish" {
+					SendRequest(req, c)
+				}
+			}
+
+		} else {
+			fmt.Println("Bad request")
+			continue
+		}
+	}
+}

client/handler/handle_topic.go

@@ -0,0 +1,38 @@
+package handler
+
+import (
+	"NonRelDB/log"
+	"bufio"
+	"fmt"
+	"net"
+	"os"
+	"os/signal"
+	"syscall"
+)
+
+// quit Handling Ctrl + C press.
+func quit(c net.Conn, topic string) {
+	sign := make(chan os.Signal, 2)
+	signal.Notify(sign, os.Interrupt, syscall.SIGTERM)
+	go func() {
+		<-sign
+		fmt.Println("Ctrl+C pressed in Terminal")
+		fmt.Fprintf(c, "unsubscribe "+topic+"\n")
+		os.Exit(0)
+	}()
+}
+
+// HandleTopic listening messages from specified topic.
+func HandleTopic(c net.Conn, r bufio.Reader, topic string) {
+	quit(c, topic)
+	fmt.Printf("Reading messages from %s... (press Ctrl + C to stop)\n", topic)
+	for {
+		msg, err := r.ReadString('\n')
+
+		if err != nil {
+			log.Error.Panicln(err.Error())
+		}
+
+		fmt.Print(msg)
+	}
+}