Merge pull request #1 from asunlabs/feature/multipleEnvs

Feature/multiple envs

Author: developerasun

.env.example

@@ -2,4 +2,4 @@ AUTHOR="developerasun"
 FOO="bar"
 SLACK_BOT_USER_OAUTH_TOKEN="xoxb-some-value-here"
 SLACK_CHANNEL_ID="channel-id-here"
-# OWLLY_DONE="true" # when update is done
+# OWLLY_DONE="true" // add this line when update is done

.gitignore

@@ -1,6 +1,16 @@
 # Configs
 .env
-config/.env.config
+.env.production
+.env.development
+.env.test
+
+# Pre-feature
+src
+
+config/*
+!config/database.go
+!config/keycode.go
+bin/*
 
 # Binaries for programs and plugins
 *.exe

README.md

@@ -20,26 +20,29 @@ A file-based .env change notifier for your slack team.
 
 ## Features
 
-- Update synchronization for .env file changes
-- Auto-post the updated .env as attachment to slack channel
+- Auto-sync .env file changes
+- Watch multiple .env files: .env, .env.test, .env.development, .env.production
+- Auto-post the update to slack channel as attachment
 - Basic metadata supported: timestamp, .env directory
+- Cross platform supported: Windows, Mac OS(intel, m1 chip)
 
 ## Install
 
-Clone this repo and compile it.
+Clone this repo and compile it. Go supports cross-compile.
 
 ```sh
 git clone https://github.com/asunlabs/owlly.git
-go build owlly.go
-```
 
-And execute owlly.exe.
+# from Windows(Powershell) to Mac OS
+$env:GOOS = "darwin"
+$env:GOARCH = "amd64"
+go build -o ./bin/owlly-for-mac owlly.go
 
-```sh
-./owlly.exe
+# for Windows
+go build -o ./bin/owlly-for-window.exe owlly.go
 ```
 
-Or, simply download executable from [release](https://github.com/asunlabs/owlly/releases/tag/ver0.1.0) and execute it.
+Or, simply download binaries from [release](https://github.com/asunlabs/owlly/releases) and execute it.
 
 ## Prerequisite
 
@@ -56,41 +59,43 @@ AUTHOR="developerasun"
 FOO="bar"
 SLACK_BOT_USER_OAUTH_TOKEN="xoxb-some-value-here"
 SLACK_CHANNEL_ID="channel-id-here"
-# OWLLY_DONE="true" # when update is done
+# OWLLY_DONE="true" // add this line when update is done
 ```
 
 ## Usage
 
-1. Run Owlly to watch .env changes.
-
-```sh
-# if you cloned a repo,
-go run owlly.go
-
-# if you executes .exe file,
-./owlly.exe
-```
-
 1. Update .env as you wish.
 
 ```sh
 FOO="bar"
 ```
 
-1. Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
+2. Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
 
 ```sh
 # length of OWLLY_DONE > 0 ? send a DM : do nothing
 OWLLY_DONE="true"
 ```
 
+3. Run Owlly to watch .env changes.
+
+```sh
+# if you cloned a repo,
+go run owlly.go
+
+# if you executes binaries,
+./owlly-for-windows.exe
+./owlly-for-mac
+./owlly-for-mac-m1
+```
+
 Check your slack channel if the message is sent.
 
 **Note**
 
-Owlly ver 0.1.0 does not support hot-reload yet. It means that you have to re-start Owlly in the situation where 1) you sent DM already 2) but updated it again 3) and want to send it again. Log will be printed but Slack API would not invoke in the case.
+Owlly ver 0.1.0 does not support hot-reload yet. It means that you have to re-start Owlly in the situation where 1) you sent DM already 2) but updated it again 3) and want to send it again.
 
-## Contributor
+## Maintainer
 
 Project Created by [developerasun](https://github.com/developerasun)
 

config/keycode.go

@@ -9,5 +9,6 @@ const (
 	Designer
 	Welfare
 
-	RESERVED = "OWLLY_DONE"
+	RESERVED   = "OWLLY_DONE"
+	OWNER_PERM = 0644
 )

owlly.go

@@ -17,8 +17,10 @@ import (
 )
 
 var (
+	watcher  *fsnotify.Watcher
 	api      *slack.Client
 	onlyOnce sync.Once
+	envList  = []string{".env", ".env.test", ".env.development", ".env.production"}
 )
 
 func nilChecker(err error) {
@@ -28,14 +30,36 @@ func nilChecker(err error) {
 	}
 }
 
-func initWatcher() *fsnotify.Watcher {
-	watcher, err := fsnotify.NewWatcher()
+func initWatcher() {
+	_watcher, err := fsnotify.NewWatcher()
 	nilChecker(err)
 
-	return watcher
+	watcher = _watcher
 }
 
+func getEnvList() []string {
+	return envList
+}
+
+// @dev start watching multiple envs
+func registerEnvs() {
+	for _, v := range getEnvList() {
+		wd, _ := os.Getwd()
+		filePath := strings.Join([]string{wd, "\\", v}, "")
+		
+		wErr := watcher.Add(filePath)
+		nilChecker(wErr)
+		color.Blue(fmt.Sprintf("watching: %v", v))
+	}
+}
+
+// @dev load multiple envs and init slack instance
 func initSlack() {
+	for _, v := range envList {
+		lErr := godotenv.Load(v)
+		nilChecker(lErr)
+	}
+
 	_api := slack.New(os.Getenv("SLACK_BOT_USER_OAUTH_TOKEN"))
 	res, err := _api.AuthTest()
 	nilChecker(err)
@@ -46,54 +70,96 @@ func initSlack() {
 	api = _api
 }
 
-func updateAndNotify() {
-	bytes, readErr := os.ReadFile("./.env")
-	nilChecker(readErr)
+func updateEnvs() {
+	wd, _ := os.Getwd()
 
-	path, _ := os.Getwd()
-	fullpath := strings.Join([]string{path, "/config/.env.config"}, "")
+	for _, v := range getEnvList() {
+		data, rErr := os.ReadFile(v)
+		nilChecker(rErr)
 
-	_, statErr := os.Stat(fullpath)
+		wrapDirName := "config"
+		wrapDirPath := strings.Join([]string{wd, "\\", wrapDirName, "\\"}, "")
+		wrapEnvName := strings.Join([]string{v, ".", wrapDirName}, "")
+		wrapEnvFile := strings.Join([]string{wrapDirPath, wrapEnvName}, "")
 
-	if os.IsNotExist(statErr) {
-		dirErr := os.Mkdir("/config", 0644)
-		nilChecker(dirErr)
+		// @dev owning user has a read and write permission: 0644
+		os.WriteFile(wrapEnvFile, data, fs.FileMode(config.OWNER_PERM))
 	}
+}
+
+func cleanupEnvs() {
+	wd, _ := os.Getwd()
+	for _, v := range getEnvList() {
+		fullPathForWrapEnv := strings.Join([]string{wd, "\\", "config", "\\", v, ".config"}, "")
+		_, sErr := os.Stat(fullPathForWrapEnv)
+
+		if ok := os.IsExist(sErr); ok {
+			rErr := os.Remove(fullPathForWrapEnv)
+			nilChecker(rErr)
+		}
 
-	filePermission := 0644
-	writeErr := os.WriteFile(fullpath, bytes, fs.FileMode(filePermission))
-	nilChecker(writeErr)
+		_, cErr := os.Create(fullPathForWrapEnv)
+		nilChecker(cErr)
 
-	// if done send a DM to slack channel
-	if isDone := isUpdateFinished(); isDone {
-		envString := convertEnvMapToString(fullpath)
-		onlyOnce.Do(func() {
-			notifyEnvChange(envString)
-		})
+		_data, rErr := os.ReadFile(v)
+		nilChecker(rErr)
+
+		wErr := os.WriteFile(fullPathForWrapEnv, _data, fs.FileMode(config.OWNER_PERM))
+		nilChecker(wErr)
 	}
+
+	color.Red("envs config setup done")
 }
 
-func isUpdateFinished() bool {
-	_data, _readErr := os.ReadFile("./.env")
-	nilChecker(_readErr)
+func sendSlackDM() {
+	wd, _ := os.Getwd()
 
-	data := string(_data)
-	isDone := strings.Contains(data, config.RESERVED)
+	// has
+	envStringMapForWrapEnv := make(map[string]string)
+	envStringForWrapEnv := "DEFAULT_VALUE"
+	
+	for _, v := range getEnvList() {
+		if isDone := isUpdateFinished(); isDone[v] {
+			fullPathForWrapEnv := strings.Join([]string{wd, "\\", "config", "\\", v, ".config"}, "")
+			wrapEnvName := strings.Join([]string{v, ".config"}, "")
 
-	log.Printf(".env in root DONE value: %v", isDone)
+			envStringForWrapEnv = convertEnvMapToString(fullPathForWrapEnv, wrapEnvName)
+			envStringMapForWrapEnv[wrapEnvName] = envStringForWrapEnv
+
+			notifyEnvChange(envStringMapForWrapEnv[wrapEnvName], v)
+		}
+	}
+}
+
+func isUpdateFinished() map[string]bool {
+	// @dev initialze a map with make
+	isDone := make(map[string]bool)
+
+	for _, v := range getEnvList() {
+		wd, _ := os.Getwd()
+		fullPath := strings.Join([]string{wd, "\\", v}, "")
+
+		_data, _rErr := os.ReadFile(fullPath)
+		nilChecker(_rErr)
+		data := string(_data)
+
+		hasOwllyTrigger := strings.Contains(data, config.RESERVED)
+		isDone[v] = hasOwllyTrigger
+	}
 
 	return isDone
 }
 
-func convertEnvMapToString(envPath string) string {
+func convertEnvMapToString(envPath string, wrapEnvName string) string {
 	dotenvMap, readErr := godotenv.Read(envPath)
 	nilChecker(readErr)
 
 	// marshaling map: ascending sort
 	marshalMsg, marshalErr := godotenv.Marshal(dotenvMap)
 	nilChecker(marshalErr)
 
-	color.Green(marshalMsg)
+	parsedMsg := fmt.Sprintf("file parsed: %v", wrapEnvName)
+	color.Green(parsedMsg)
 
 	return marshalMsg
 }
@@ -109,11 +175,12 @@ func getUpdateMetadata() (string, string) {
 	return date, dirPath // yyyy-mm-dd hh-mm
 }
 
-func notifyEnvChange(envString string) {
+func notifyEnvChange(envString string, envFileName string) {
 	date, dirPath := getUpdateMetadata()
-	dateMsg := fmt.Sprintf(".env updated at: %v", date)
-	pathMsg := fmt.Sprintf(".env directory is: %v", dirPath)
+	dateMsg := fmt.Sprintf("%v updated at: %v", envFileName, date)
+	pathMsg := fmt.Sprintf("directory is: %v", dirPath)
 
+	// @dev assert a parsed env value is thread-safe
 	attachedEnv := slack.AttachmentField{
 		Title: "Copy and paste below texts to update",
 		Value: envString,
@@ -136,20 +203,23 @@ func notifyEnvChange(envString string) {
 		postWhat,
 		postAs,
 	)
-	
+
 	nilChecker(msgErr)
 
 	resultMessage := fmt.Sprintf("message posted to channel %v at %v", channelID, date)
 	color.Green(resultMessage)
 }
 
 func main() {
-	envErr := godotenv.Load(".env")
+	cleanupEnvs()
 
-	nilChecker(envErr)
+	onlyOnce.Do(func() {
+		initSlack()
+		initWatcher()
+	})
 
-	initSlack()
-	watcher := initWatcher()
+	/// @dev starts monitoring the path for changes.
+	registerEnvs()
 
 	go func() {
 		for {
@@ -160,7 +230,7 @@ func main() {
 				}
 				if event.Has(fsnotify.Write) {
 					log.Println("modified file: ", event.Name)
-					updateAndNotify()
+					updateEnvs()
 				}
 			case err, ok := <-watcher.Errors:
 				nilChecker(err)
@@ -171,10 +241,7 @@ func main() {
 		}
 	}()
 
-	/// @dev starts monitoring the path for changes.
-	watcherErr := watcher.Add(".env")
-	nilChecker(watcherErr)
-
-	// Block main goroutine forever.
-	<-make(chan struct{})
+	sendSlackDM()
+	color.Blue("WORK DONE! Exit Owlly 👋")
+	os.Exit(1)
 }