Compare commits

14 Commits

Author SHA1 Message Date
Spencer Brower
06e0d8067c chore(main): release 0.2.0 2025-11-10 10:20:56 -05:00
4db0a4d33d feat(sync): envr can now detect if directories have moved. 2025-11-10 10:13:18 -05:00
638751fb48 refactor: Restore and Sync now share code through the sync function. 2025-11-10 10:13:18 -05:00
39dc586d3c refactor: Swapped position of Sync and Restore for better readability. 2025-11-10 10:13:18 -05:00
5eaf691dcd refactor(db): Removed the need to pass CloseMode to Db.Close. 2025-11-07 14:43:30 -05:00
1a3172dc6f docs: Updated comments on SshKeyPair. 2025-11-07 12:19:29 -05:00
66b113049b refactor: Removed TODOs. 2025-11-07 11:51:11 -05:00
169653d756 feat(init): Added a --force flag for overwriting an existing config. 2025-11-07 11:48:36 -05:00
8074f7ae6d feat(sync): Now checks files for mismatched hashes before replacing. 2025-11-07 11:38:58 -05:00
9a729e6e2a docs: Removed old TODO. 2025-11-07 11:16:27 -05:00
0fef74a9bb refactor!: Dir is no longer stored in the database.
BREAKING CHANGE: Dir is now derived from Path rather than stored in the
DB. Your DB will need to be updated.
2025-11-07 11:12:29 -05:00
38a6776b31 chore: remotes now get unmarshalled from the database. 2025-11-07 10:54:54 -05:00
15be62b5a2 feat(config): The default config now filters out more junk.
This includes `.envrc` files, `.local/`, `node_modules`, and `vendor`.
2025-11-07 10:44:55 -05:00
f43705cd53 feat(scan)!: Added support for multiple exports.
BREAKING CHANGE: The config value `scan.Exclude` is now a list rather than a string.
2025-11-07 10:41:46 -05:00
18 changed files with 357 additions and 115 deletions

View File

@@ -1,5 +1,36 @@
# Changelog # Changelog
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-10)
### ⚠ BREAKING CHANGES
* Dir is now derived from Path rather than stored in the DB. Your DB will need to be updated.
* **scan:** The config value `scan.Exclude` is now a list rather than a string.
* **check:** Renamed the `check` command to `deps`.
* The config value `scan.Include` is now a list rather than a string.
### Features
* Added new `check` command. ([cbd74f3](https://github.com/sbrow/envr/commit/cbd74f387e2e330b2557d07dd82ba05cc91300ac))
* **config:** The default config now filters out more junk. ([15be62b](https://github.com/sbrow/envr/commit/15be62b5a2a5a735b90b074497d645c5a2cfced8))
* **init:** Added a `--force` flag for overwriting an existing config. ([169653d](https://github.com/sbrow/envr/commit/169653d7566f63730fb9da80a18330a566223be9))
* Multiple scan includes are now supported. ([4273fa5](https://github.com/sbrow/envr/commit/4273fa58956d8736271a0af66202dca481126fe4))
* **scan:** Added support for multiple exports. ([f43705c](https://github.com/sbrow/envr/commit/f43705cd53c6d87aef1f69df4e474441f25c1dc7))
* **sync:** envr can now detect if directories have moved. ([4db0a4d](https://github.com/sbrow/envr/commit/4db0a4d33d2b6a79d13b36a8e8631f895e8fef8d))
* **sync:** Now checks files for mismatched hashes before replacing. ([8074f7a](https://github.com/sbrow/envr/commit/8074f7ae6dfa54e931a198257f3f8e6d0cfe353a))
### Bug Fixes
* **check:** `fd` now correctly gets marked as found. ([17ce49c](https://github.com/sbrow/envr/commit/17ce49cd2d33942282c6f54ce819ac25978f6b7c))
### Code Refactoring
* **check:** Renamed the `check` command to `deps`. ([c9c34ce](https://github.com/sbrow/envr/commit/c9c34ce771653da214635f1df1fef1f23265c552))
* Dir is no longer stored in the database. ([0fef74a](https://github.com/sbrow/envr/commit/0fef74a9bba0fbf3c34b66c2095955e6eee7047b))
## [0.1.1](https://github.com/sbrow/envr/compare/v0.1.0...v0.1.1) (2025-11-05) ## [0.1.1](https://github.com/sbrow/envr/compare/v0.1.0...v0.1.1) (2025-11-05)

View File

@@ -19,10 +19,11 @@ be run on a cron.
- 🔍 **Smart Scanning**: Automatically discover and import `.env` files in your - 🔍 **Smart Scanning**: Automatically discover and import `.env` files in your
home directory. home directory.
-**Interactive CLI**: User-friendly prompts for file selection and management. -**Interactive CLI**: User-friendly prompts for file selection and management.
- 🗂️ **Rename Detection**: Automatically finds and updates renamed/moved
repositories.
## TODOS ## TODOS
- [x] Rename Detection: automatically update moved files.
- [ ] 🗂️ **Rename Detection**: Automatically handle renamed repositories.
- [ ] Allow use of keys from `ssh-agent` - [ ] Allow use of keys from `ssh-agent`
- [x] Allow configuration of ssh key. - [x] Allow configuration of ssh key.
- [x] Allow multiple ssh keys. - [x] Allow multiple ssh keys.

View File

@@ -6,6 +6,7 @@ import (
"fmt" "fmt"
"os" "os"
"os/exec" "os/exec"
"path"
"path/filepath" "path/filepath"
"strings" "strings"
@@ -18,6 +19,7 @@ type Config struct {
ScanConfig scanConfig `json:"scan"` ScanConfig scanConfig `json:"scan"`
} }
// Used by age to encrypt and decrypt the database.
type SshKeyPair struct { type SshKeyPair struct {
Private string `json:"private"` // Path to the private key file Private string `json:"private"` // Path to the private key file
Public string `json:"public"` // Path to the public key file Public string `json:"public"` // Path to the public key file
@@ -26,8 +28,7 @@ type SshKeyPair struct {
type scanConfig struct { type scanConfig struct {
// TODO: Support multiple matchers // TODO: Support multiple matchers
Matcher string `json:"matcher"` Matcher string `json:"matcher"`
// TODO: Support multiple excludes Exclude []string `json:"exclude"`
Exclude string `json:"exclude"`
Include []string `json:"include"` Include []string `json:"include"`
} }
@@ -48,7 +49,12 @@ func NewConfig(privateKeyPaths []string) Config {
Keys: keys, Keys: keys,
ScanConfig: scanConfig{ ScanConfig: scanConfig{
Matcher: "\\.env", Matcher: "\\.env",
Exclude: "*.envrc", Exclude: []string{
"*\\.envrc",
"\\.local/",
"node_modules",
"vendor",
},
Include: []string{"~"}, Include: []string{"~"},
}, },
} }
@@ -109,6 +115,25 @@ func (c *Config) Save() error {
return os.WriteFile(configPath, data, 0644) return os.WriteFile(configPath, data, 0644)
} }
// buildFdArgs builds the fd command arguments with multiple exclude patterns
func (c Config) buildFdArgs(searchPath string, includeIgnored bool) []string {
args := []string{"-a", c.ScanConfig.Matcher}
// Add exclude patterns
for _, exclude := range c.ScanConfig.Exclude {
args = append(args, "-E", exclude)
}
if includeIgnored {
args = append(args, "-HI")
} else {
args = append(args, "-H")
}
args = append(args, searchPath)
return args
}
// Use fd to find all ignored .env files that match the config's parameters // Use fd to find all ignored .env files that match the config's parameters
func (c Config) scan() (paths []string, err error) { func (c Config) scan() (paths []string, err error) {
searchPaths, err := c.searchPaths() searchPaths, err := c.searchPaths()
@@ -119,7 +144,7 @@ func (c Config) scan() (paths []string, err error) {
for _, searchPath := range searchPaths { for _, searchPath := range searchPaths {
// Find all files (including ignored ones) // Find all files (including ignored ones)
fmt.Printf("Searching for all files in \"%s\"...\n", searchPath) fmt.Printf("Searching for all files in \"%s\"...\n", searchPath)
allCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-HI", searchPath) allCmd := exec.Command("fd", c.buildFdArgs(searchPath, true)...)
allOutput, err := allCmd.Output() allOutput, err := allCmd.Output()
if err != nil { if err != nil {
return paths, err return paths, err
@@ -132,7 +157,7 @@ func (c Config) scan() (paths []string, err error) {
// Find unignored files // Find unignored files
fmt.Printf("Search for unignored fies in \"%s\"...\n", searchPath) fmt.Printf("Search for unignored fies in \"%s\"...\n", searchPath)
unignoredCmd := exec.Command("fd", "-a", c.ScanConfig.Matcher, "-E", c.ScanConfig.Exclude, "-H", searchPath) unignoredCmd := exec.Command("fd", c.buildFdArgs(searchPath, false)...)
unignoredOutput, err := unignoredCmd.Output() unignoredOutput, err := unignoredCmd.Output()
if err != nil { if err != nil {
return []string{}, err return []string{}, err
@@ -184,8 +209,7 @@ func (c Config) searchPaths() (paths []string, err error) {
return paths, nil return paths, nil
} }
// TODO: Should this be private? func (s SshKeyPair) identity() (age.Identity, error) {
func (s SshKeyPair) Identity() (age.Identity, error) {
sshKey, err := os.ReadFile(s.Private) sshKey, err := os.ReadFile(s.Private)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to read SSH key: %w", err) return nil, fmt.Errorf("failed to read SSH key: %w", err)
@@ -199,8 +223,7 @@ func (s SshKeyPair) Identity() (age.Identity, error) {
return id, nil return id, nil
} }
// TODO: Should this be private? func (s SshKeyPair) recipient() (age.Recipient, error) {
func (s SshKeyPair) Recipient() (age.Recipient, error) {
sshKey, err := os.ReadFile(s.Public) sshKey, err := os.ReadFile(s.Public)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to read SSH key: %w", err) return nil, fmt.Errorf("failed to read SSH key: %w", err)
@@ -213,3 +236,32 @@ func (s SshKeyPair) Recipient() (age.Recipient, error) {
return id, nil return id, nil
} }
// Use fd to find all git roots in the config's search paths
func (c Config) findGitRoots() (paths []string, err error) {
searchPaths, err := c.searchPaths()
if err != nil {
return []string{}, err
}
for _, searchPath := range searchPaths {
allCmd := exec.Command("fd", "-H", "-t", "d", "^\\.git$", searchPath)
allOutput, err := allCmd.Output()
if err != nil {
return paths, err
}
allFiles := strings.Split(strings.TrimSpace(string(allOutput)), "\n")
if len(allFiles) == 1 && allFiles[0] == "" {
allFiles = []string{}
}
for i, file := range allFiles {
allFiles[i] = path.Dir(path.Clean(file))
}
paths = append(paths, allFiles...)
}
return paths, nil
}

View File

@@ -1,5 +1,6 @@
package app package app
// TODO: app/db.go should be reviewed.
import ( import (
"database/sql" "database/sql"
"encoding/json" "encoding/json"
@@ -13,19 +14,12 @@ import (
_ "modernc.org/sqlite" _ "modernc.org/sqlite"
) )
// CloseMode determines whether or not the in-memory DB should be saved to disk
// before closing the connection.
type CloseMode int
const (
ReadOnly CloseMode = iota
Write
)
type Db struct { type Db struct {
db *sql.DB db *sql.DB
cfg Config cfg Config
features *AvailableFeatures features *AvailableFeatures
// If true, the database will be saved to disk before closing
changed bool
} }
func Open() (*Db, error) { func Open() (*Db, error) {
@@ -37,7 +31,7 @@ func Open() (*Db, error) {
if _, err := os.Stat("/home/spencer/.envr/data.age"); err != nil { if _, err := os.Stat("/home/spencer/.envr/data.age"); err != nil {
// Create a new DB // Create a new DB
db, err := newDb() db, err := newDb()
return &Db{db, *cfg, nil}, err return &Db{db, *cfg, nil, true}, err
} else { } else {
// Open the existing DB // Open the existing DB
tmpFile, err := os.CreateTemp("", "envr-*.db") tmpFile, err := os.CreateTemp("", "envr-*.db")
@@ -59,7 +53,7 @@ func Open() (*Db, error) {
restoreDB(tmpFile.Name(), memDb) restoreDB(tmpFile.Name(), memDb)
return &Db{memDb, *cfg, nil}, nil return &Db{memDb, *cfg, nil, false}, nil
} }
} }
@@ -72,7 +66,6 @@ func newDb() (*sql.DB, error) {
} else { } else {
_, err := db.Exec(`create table envr_env_files ( _, err := db.Exec(`create table envr_env_files (
path text primary key not null path text primary key not null
, dir text not null
, remotes text -- JSON , remotes text -- JSON
, sha256 text not null , sha256 text not null
, contents text not null , contents text not null
@@ -108,7 +101,7 @@ func decryptDb(tmpFilePath string, keys []SshKeyPair) error {
identities := make([]age.Identity, 0, len(keys)) identities := make([]age.Identity, 0, len(keys))
for _, key := range keys { for _, key := range keys {
id, err := key.Identity() id, err := key.identity()
if err != nil { if err != nil {
return err return err
@@ -150,7 +143,7 @@ func restoreDB(path string, destDB *sql.DB) error {
// Returns all the EnvFiles present in the database. // Returns all the EnvFiles present in the database.
func (db *Db) List() (results []EnvFile, err error) { func (db *Db) List() (results []EnvFile, err error) {
rows, err := db.db.Query("select * from envr_env_files") rows, err := db.db.Query("select path, remotes, sha256, contents from envr_env_files")
if err != nil { if err != nil {
return nil, err return nil, err
@@ -159,14 +152,18 @@ func (db *Db) List() (results []EnvFile, err error) {
for rows.Next() { for rows.Next() {
var envFile EnvFile var envFile EnvFile
var remotesJSON string var remotesJson []byte
err := rows.Scan(&envFile.Path, &remotesJson, &envFile.Sha256, &envFile.contents)
err := rows.Scan(&envFile.Path, &envFile.Dir, &remotesJSON, &envFile.Sha256, &envFile.contents)
if err != nil { if err != nil {
return nil, err return nil, err
} }
// TODO: unmarshal remotesJSON into envFile.remotes // Populate Dir from Path
envFile.Dir = filepath.Dir(envFile.Path)
if err := json.Unmarshal(remotesJson, &envFile.Remotes); err != nil {
return nil, err
}
results = append(results, envFile) results = append(results, envFile)
} }
@@ -178,10 +175,10 @@ func (db *Db) List() (results []EnvFile, err error) {
return results, nil return results, nil
} }
func (db *Db) Close(mode CloseMode) error { func (db *Db) Close() error {
defer db.db.Close() defer db.db.Close()
if mode == Write { if db.changed {
// Create tmp file // Create tmp file
tmpFile, err := os.CreateTemp("", "envr-*.db") tmpFile, err := os.CreateTemp("", "envr-*.db")
if err != nil { if err != nil {
@@ -197,6 +194,8 @@ func (db *Db) Close(mode CloseMode) error {
if err := encryptDb(tmpFile.Name(), db.cfg.Keys); err != nil { if err := encryptDb(tmpFile.Name(), db.cfg.Keys); err != nil {
return err return err
} }
db.changed = false
} }
return nil return nil
@@ -242,7 +241,7 @@ func encryptDb(tmpFilePath string, keys []SshKeyPair) error {
recipients := make([]age.Recipient, 0, len(keys)) recipients := make([]age.Recipient, 0, len(keys))
for _, key := range keys { for _, key := range keys {
recipient, err := key.Recipient() recipient, err := key.recipient()
if err != nil { if err != nil {
return err return err
@@ -278,14 +277,16 @@ func (db *Db) Insert(file EnvFile) error {
// Insert into database // Insert into database
_, err = db.db.Exec(` _, err = db.db.Exec(`
INSERT OR REPLACE INTO envr_env_files (path, dir, remotes, sha256, contents) INSERT OR REPLACE INTO envr_env_files (path, remotes, sha256, contents)
VALUES (?, ?, ?, ?, ?) VALUES (?, ?, ?, ?)
`, file.Path, file.Dir, string(remotesJSON), file.Sha256, file.contents) `, file.Path, string(remotesJSON), file.Sha256, file.contents)
if err != nil { if err != nil {
return fmt.Errorf("failed to insert env file: %w", err) return fmt.Errorf("failed to insert env file: %w", err)
} }
db.changed = true
return nil return nil
} }
@@ -293,12 +294,15 @@ func (db *Db) Insert(file EnvFile) error {
func (db *Db) Fetch(path string) (envFile EnvFile, err error) { func (db *Db) Fetch(path string) (envFile EnvFile, err error) {
var remotesJSON string var remotesJSON string
row := db.db.QueryRow("SELECT path, dir, remotes, sha256, contents FROM envr_env_files WHERE path = ?", path) row := db.db.QueryRow("SELECT path, remotes, sha256, contents FROM envr_env_files WHERE path = ?", path)
err = row.Scan(&envFile.Path, &envFile.Dir, &remotesJSON, &envFile.Sha256, &envFile.contents) err = row.Scan(&envFile.Path, &remotesJSON, &envFile.Sha256, &envFile.contents)
if err != nil { if err != nil {
return EnvFile{}, fmt.Errorf("failed to fetch env file: %w", err) return EnvFile{}, fmt.Errorf("failed to fetch env file: %w", err)
} }
// Populate Dir from Path
envFile.Dir = filepath.Dir(envFile.Path)
if err = json.Unmarshal([]byte(remotesJSON), &envFile.Remotes); err != nil { if err = json.Unmarshal([]byte(remotesJSON), &envFile.Remotes); err != nil {
return EnvFile{}, fmt.Errorf("failed to unmarshal remotes: %w", err) return EnvFile{}, fmt.Errorf("failed to unmarshal remotes: %w", err)
} }
@@ -322,6 +326,8 @@ func (db *Db) Delete(path string) error {
return fmt.Errorf("no file found with path: %s", path) return fmt.Errorf("no file found with path: %s", path)
} }
db.changed = true
return nil return nil
} }
@@ -381,3 +387,35 @@ func (db *Db) CanScan() error {
return nil return nil
} }
} }
// If true, [Db.Insert] should be called on the [EnvFile] that generated
// the given result
func (db Db) UpdateRequired(status EnvFileSyncResult) bool {
return status&(BackedUp|DirUpdated) != 0
}
func (db *Db) Sync(file *EnvFile) (result EnvFileSyncResult, err error) {
// TODO: This results in findMovedDirs being called multiple times.
return file.sync(TrustFilesystem, db)
}
// Looks for git directories that share one or more git remotes with
// the given file.
func (db Db) findMovedDirs(file *EnvFile) (movedDirs []string, err error) {
if err = db.Features().validateFeatures(Fd, Git); err != nil {
return movedDirs, err
}
gitRoots, err := db.cfg.findGitRoots()
if err != nil {
return movedDirs, err
} else {
for _, dir := range gitRoots {
if file.sharesRemote(getGitRemotes(dir)) {
movedDirs = append(movedDirs, dir)
}
}
return movedDirs, nil
}
}

View File

@@ -2,15 +2,19 @@ package app
import ( import (
"crypto/sha256" "crypto/sha256"
"errors"
"fmt" "fmt"
"os" "os"
"os/exec" "os/exec"
"path"
"path/filepath" "path/filepath"
"strings" "strings"
) )
type EnvFile struct { type EnvFile struct {
// TODO: Should use FileName in the struct and derive from the path.
Path string Path string
// Dir is derived from Path, and is not stored in the database.
Dir string Dir string
Remotes []string // []string Remotes []string // []string
Sha256 string Sha256 string
@@ -21,16 +25,30 @@ type EnvFile struct {
type EnvFileSyncResult int type EnvFileSyncResult int
const ( const (
// The struct has been updated from the filesystem
// and should be updated in the database.
Updated EnvFileSyncResult = iota
// The filesystem has been restored to match the struct
// no further action is required.
Restored
Error
// The filesystem contents matches the struct // The filesystem contents matches the struct
// no further action is required. // no further action is required.
Noop Noop EnvFileSyncResult = 0
// The directory changed, but the file contents matched.
// The database must be updated.
DirUpdated EnvFileSyncResult = 1
// The filesystem has been restored to match the struct
// no further action is required.
Restored EnvFileSyncResult = 1 << 1
// The filesystem has been restored to match the struct.
// The directory changed, so the database must be updated
RestoredAndDirUpdated EnvFileSyncResult = Restored | DirUpdated
// The struct has been updated from the filesystem
// and should be updated in the database.
BackedUp EnvFileSyncResult = 1 << 2
Error EnvFileSyncResult = 1 << 3
)
// Determines the source of truth when calling [EnvFile.Sync] or [EnvFile.Restore]
type syncDirection int
const (
TrustDatabase syncDirection = iota
TrustFilesystem
) )
func NewEnvFile(path string) EnvFile { func NewEnvFile(path string) EnvFile {
@@ -95,62 +113,119 @@ func getGitRemotes(dir string) []string {
return remotes return remotes
} }
// Install the file into the file system // Reconcile the state of the database with the state of the filesystem, using
func (file EnvFile) Restore() error { // dir to determine which side to use a the source of truth.
// TODO: Handle restores more cleanly func (f *EnvFile) sync(dir syncDirection, db *Db) (result EnvFileSyncResult, err error) {
// Ensure the directory exists if result != Noop {
if _, err := os.Stat(file.Dir); err != nil { panic("Invalid state")
return fmt.Errorf("directory missing")
} }
// Check if file already exists if _, err := os.Stat(f.Dir); err != nil {
if _, err := os.Stat(file.Path); err == nil { // Directory doesn't exist
return fmt.Errorf("file already exists: %s", file.Path)
var movedDirs []string
if db != nil {
movedDirs, err = db.findMovedDirs(f)
}
if err != nil {
return Error, err
} else {
switch len(movedDirs) {
case 0:
return Error, fmt.Errorf("directory missing")
case 1:
f.updateDir(movedDirs[0])
result |= DirUpdated
default:
return Error, fmt.Errorf("multiple directories found")
}
}
} }
// Write the contents to the file if _, err := os.Stat(f.Path); err != nil {
if err := os.WriteFile(file.Path, []byte(file.contents), 0644); err != nil { if errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("failed to write file: %w", err) if err := os.WriteFile(f.Path, []byte(f.contents), 0644); err != nil {
return Error, fmt.Errorf("failed to write file: %w", err)
} }
return nil return result | Restored, nil
} else {
return Error, err
}
} else {
// File exists, check its hash
contents, err := os.ReadFile(f.Path)
if err != nil {
return Error, fmt.Errorf("failed to read file for SHA comparison: %w", err)
}
hash := sha256.Sum256(contents)
currentSha := fmt.Sprintf("%x", hash)
// Compare the hashes
if currentSha == f.Sha256 {
// No op, or DirUpdated
return result, nil
} else {
switch dir {
case TrustDatabase:
if err := os.WriteFile(f.Path, []byte(f.contents), 0644); err != nil {
return Error, fmt.Errorf("failed to write file: %w", err)
}
return result | Restored, nil
case TrustFilesystem:
// Overwrite the database
if err = f.Backup(); err != nil {
return Error, err
} else {
return BackedUp, nil
}
default:
panic("unknown sync direction")
}
}
}
}
func (f *EnvFile) sharesRemote(remotes []string) bool {
rMap := make(map[string]bool)
for _, remote := range f.Remotes {
rMap[remote] = true
}
for _, remote := range remotes {
if rMap[remote] {
return true
}
}
return false
}
func (f *EnvFile) updateDir(newDir string) {
f.Dir = newDir
f.Path = path.Join(newDir, path.Base(f.Path))
f.Remotes = getGitRemotes(newDir)
} }
// Try to reconcile the EnvFile with the filesystem. // Try to reconcile the EnvFile with the filesystem.
// //
// If Updated is returned, [Db.Insert] should be called on file. // If Updated is returned, [Db.Insert] should be called on file.
func (file *EnvFile) Sync() (result EnvFileSyncResult, err error) { func (file *EnvFile) Sync() (result EnvFileSyncResult, err error) {
// Check if the path exists in the file system return file.sync(TrustFilesystem, nil)
_, err = os.Stat(file.Path)
if err == nil {
contents, err := os.ReadFile(file.Path)
if err != nil {
return Error, fmt.Errorf("failed to read file for SHA comparison: %w", err)
}
// Check if sha matches by reading the current file and calculating its hash
hash := sha256.Sum256(contents)
currentSha := fmt.Sprintf("%x", hash)
if file.Sha256 == currentSha {
// Nothing to do
return Noop, nil
} else {
if err = file.Backup(); err != nil {
return Error, err
} else {
return Updated, nil
}
}
} else {
if err = file.Restore(); err != nil {
return Error, err
} else {
return Restored, nil
}
}
} }
// Update the EnvFile using the file system // Install the file into the file system. If the file already exists,
// it will be overwritten.
func (file EnvFile) Restore() error {
_, err := file.sync(TrustDatabase, nil)
return err
}
// Update the EnvFile using the file system.
func (file *EnvFile) Backup() error { func (file *EnvFile) Backup() error {
// Read the contents of the file // Read the contents of the file
contents, err := os.ReadFile(file.Path) contents, err := os.ReadFile(file.Path)

View File

@@ -1,9 +1,20 @@
package app package app
import ( import (
"fmt"
"os/exec" "os/exec"
) )
type MissingFeatureError struct {
feature AvailableFeatures
}
func (m *MissingFeatureError) Error() string {
return fmt.Sprintf("Missing \"%s\" feature", m.feature)
}
// TODO: Features should really be renamed to Binaries
// Represents which binaries are present in $PATH. // Represents which binaries are present in $PATH.
// Used to fail safely when required features are unavailable // Used to fail safely when required features are unavailable
type AvailableFeatures int type AvailableFeatures int
@@ -30,3 +41,20 @@ func checkFeatures() (feats AvailableFeatures) {
return feats return feats
} }
// Returns a MissingFeature error if the given features aren't present.
func (a AvailableFeatures) validateFeatures(features ...AvailableFeatures) error {
var missing AvailableFeatures
for _, feat := range features {
if a&feat == 0 {
missing |= feat
}
}
if missing == 0 {
return nil
} else {
return &MissingFeatureError{missing}
}
}

View File

@@ -27,11 +27,11 @@ var backupCmd = &cobra.Command{
if err != nil { if err != nil {
return err return err
} else { } else {
defer db.Close(app.Write) defer db.Close()
record := app.NewEnvFile(path) record := app.NewEnvFile(path)
if err := db.Insert(record); err != nil { if err := db.Insert(record); err != nil {
panic(err) return err
} else { } else {
fmt.Printf("Saved %s into the database", path) fmt.Printf("Saved %s into the database", path)
return nil return nil

View File

@@ -38,7 +38,7 @@ var checkCmd = &cobra.Command{
if err != nil { if err != nil {
return fmt.Errorf("failed to open database: %w", err) return fmt.Errorf("failed to open database: %w", err)
} }
defer db.Close(app.ReadOnly) defer db.Close()
// Check if the path is a file or directory // Check if the path is a file or directory
info, err := os.Stat(absPath) info, err := os.Stat(absPath)

View File

@@ -19,7 +19,7 @@ The check command reports on which binaries are available and which are not.`,
if err != nil { if err != nil {
return err return err
} else { } else {
defer db.Close(app.ReadOnly) defer db.Close()
features := db.Features() features := db.Features()
table := tablewriter.NewWriter(os.Stdout) table := tablewriter.NewWriter(os.Stdout)

View File

@@ -11,10 +11,8 @@ import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
// TODO: Add --force (-f) flag.
var initCmd = &cobra.Command{ var initCmd = &cobra.Command{
Use: "init", Use: "init",
DisableFlagsInUseLine: true,
Short: "Set up envr", Short: "Set up envr",
Long: `The init command generates your initial config and saves it to Long: `The init command generates your initial config and saves it to
~/.envr/config in JSON format. ~/.envr/config in JSON format.
@@ -23,11 +21,10 @@ During setup, you will be prompted to select one or more ssh keys with which to
encrypt your databse. **Make 100% sure** that you have **a remote copy** of this encrypt your databse. **Make 100% sure** that you have **a remote copy** of this
key somewhere, otherwise your data could be lost forever.`, key somewhere, otherwise your data could be lost forever.`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
force, _ := cmd.Flags().GetBool("force")
config, _ := app.LoadConfig() config, _ := app.LoadConfig()
if config != nil { if config == nil || force {
return fmt.Errorf("You have already initialized envr")
} else {
keys, err := selectSSHKeys() keys, err := selectSSHKeys()
if err != nil { if err != nil {
return fmt.Errorf("Error selecting SSH keys: %v", err) return fmt.Errorf("Error selecting SSH keys: %v", err)
@@ -43,13 +40,17 @@ key somewhere, otherwise your data could be lost forever.`,
} }
fmt.Printf("Config initialized with %d SSH key(s). You are ready to use envr.\n", len(keys)) fmt.Printf("Config initialized with %d SSH key(s). You are ready to use envr.\n", len(keys))
}
return nil return nil
} else {
return fmt.Errorf(`You have already initialized envr.
Run again with the --force flag if you want to reinitialize.
`)
}
}, },
} }
func init() { func init() {
initCmd.Flags().BoolP("force", "f", false, "Overwrite an existing config")
rootCmd.AddCommand(initCmd) rootCmd.AddCommand(initCmd)
} }

View File

@@ -24,7 +24,7 @@ var listCmd = &cobra.Command{
if err != nil { if err != nil {
return err return err
} }
defer db.Close(app.ReadOnly) defer db.Close()
rows, err := db.List() rows, err := db.List()
if err != nil { if err != nil {

View File

@@ -25,7 +25,7 @@ var removeCmd = &cobra.Command{
if err != nil { if err != nil {
return err return err
} else { } else {
defer db.Close(app.Write) defer db.Close()
if err := db.Delete(path); err != nil { if err := db.Delete(path); err != nil {
return err return err
} else { } else {

View File

@@ -27,7 +27,7 @@ var restoreCmd = &cobra.Command{
if err != nil { if err != nil {
return err return err
} else { } else {
defer db.Close(app.ReadOnly) defer db.Close()
record, err := db.Fetch(path) record, err := db.Fetch(path)
if err != nil { if err != nil {

View File

@@ -57,7 +57,7 @@ var scanCmd = &cobra.Command{
// Close database with write mode to persist changes // Close database with write mode to persist changes
if addedCount > 0 { if addedCount > 0 {
err = db.Close(app.Write) err = db.Close()
if err != nil { if err != nil {
return fmt.Errorf("Error saving changes: %v\n", err) return fmt.Errorf("Error saving changes: %v\n", err)
} else { } else {
@@ -65,7 +65,7 @@ var scanCmd = &cobra.Command{
return nil return nil
} }
} else { } else {
err = db.Close(app.ReadOnly) err = db.Close()
if err != nil { if err != nil {
return fmt.Errorf("Error closing database: %v\n", err) return fmt.Errorf("Error closing database: %v\n", err)
} }

View File

@@ -10,16 +10,16 @@ import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
// TODO: Detect when file paths have moved and update accordingly.
var syncCmd = &cobra.Command{ var syncCmd = &cobra.Command{
Use: "sync", Use: "sync",
Short: "Update or restore your env backups", Short: "Update or restore your env backups",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
db, err := app.Open() db, err := app.Open()
if err != nil { if err != nil {
return err return err
} else { } else {
defer db.Close(app.Write) defer db.Close()
files, err := db.List() files, err := db.List()
if err != nil { if err != nil {
@@ -33,16 +33,19 @@ var syncCmd = &cobra.Command{
for _, file := range files { for _, file := range files {
// Syncronize the filesystem with the database. // Syncronize the filesystem with the database.
changed, err := file.Sync() oldPath := file.Path
changed, err := db.Sync(&file)
var status string var status string
switch changed { switch changed {
case app.Updated: case app.BackedUp:
status = "Backed Up" status = "Backed Up"
if err := db.Insert(file); err != nil { if err := db.Insert(file); err != nil {
return err return err
} }
case app.Restored: case app.Restored:
fallthrough
case app.RestoredAndDirUpdated:
status = "Restored" status = "Restored"
case app.Error: case app.Error:
if err == nil { if err == nil {
@@ -51,10 +54,23 @@ var syncCmd = &cobra.Command{
status = err.Error() status = err.Error()
case app.Noop: case app.Noop:
status = "OK" status = "OK"
case app.DirUpdated:
status = "Moved"
default: default:
panic("Unknown result") panic("Unknown result")
} }
if changed&app.DirUpdated == app.DirUpdated {
if err := db.Delete(oldPath); err != nil {
return err
}
}
if db.UpdateRequired(changed) {
if err := db.Insert(file); err != nil {
return err
}
}
results = append(results, syncResult{ results = append(results, syncResult{
Path: file.Path, Path: file.Path,
Status: status, Status: status,

View File

@@ -12,12 +12,13 @@ encrypt your databse. **Make 100% sure** that you have **a remote copy** of this
key somewhere, otherwise your data could be lost forever. key somewhere, otherwise your data could be lost forever.
``` ```
envr init envr init [flags]
``` ```
### Options ### Options
``` ```
-f, --force Overwrite an existing config
-h, --help help for init -h, --help help for init
``` ```

View File

@@ -61,7 +61,7 @@
packages.default = pkgs.buildGoModule rec { packages.default = pkgs.buildGoModule rec {
pname = "envr"; pname = "envr";
version = "0.1.1"; version = "0.2.0";
src = ./.; src = ./.;
# If the build complains, uncomment this line # If the build complains, uncomment this line
# vendorHash = "sha256:0000000000000000000000000000000000000000000000000000"; # vendorHash = "sha256:0000000000000000000000000000000000000000000000000000";

View File

@@ -2,7 +2,6 @@ package main
import "github.com/sbrow/envr/cmd" import "github.com/sbrow/envr/cmd"
// TODO: `envr check` command that looks in cwd and tells you if it's backed up or not.
func main() { func main() {
cmd.Execute() cmd.Execute()
} }