1 Commits

Author SHA1 Message Date
Spencer Brower
47fec65063 chore(main): release 0.2.0 2025-11-07 11:48:54 -05:00
15 changed files with 100 additions and 259 deletions

View File

@@ -1,6 +1,6 @@
# Changelog # Changelog
## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-10) ## [0.2.0](https://github.com/sbrow/envr/compare/v0.1.1...v0.2.0) (2025-11-07)
### ⚠ BREAKING CHANGES ### ⚠ BREAKING CHANGES
@@ -17,7 +17,6 @@
* **init:** Added a `--force` flag for overwriting an existing config. ([169653d](https://github.com/sbrow/envr/commit/169653d7566f63730fb9da80a18330a566223be9)) * **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)) * 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)) * **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)) * **sync:** Now checks files for mismatched hashes before replacing. ([8074f7a](https://github.com/sbrow/envr/commit/8074f7ae6dfa54e931a198257f3f8e6d0cfe353a))

View File

@@ -19,11 +19,10 @@ 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,7 +6,6 @@ import (
"fmt" "fmt"
"os" "os"
"os/exec" "os/exec"
"path"
"path/filepath" "path/filepath"
"strings" "strings"
@@ -19,7 +18,6 @@ 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
@@ -209,7 +207,8 @@ func (c Config) searchPaths() (paths []string, err error) {
return paths, nil return paths, nil
} }
func (s SshKeyPair) identity() (age.Identity, error) { // TODO: Should this be private?
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)
@@ -223,7 +222,8 @@ func (s SshKeyPair) identity() (age.Identity, error) {
return id, nil return id, nil
} }
func (s SshKeyPair) recipient() (age.Recipient, error) { // TODO: Should this be private?
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)
@@ -236,32 +236,3 @@ 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,6 +1,5 @@
package app package app
// TODO: app/db.go should be reviewed.
import ( import (
"database/sql" "database/sql"
"encoding/json" "encoding/json"
@@ -14,12 +13,19 @@ 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) {
@@ -31,7 +37,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, true}, err return &Db{db, *cfg, nil}, err
} else { } else {
// Open the existing DB // Open the existing DB
tmpFile, err := os.CreateTemp("", "envr-*.db") tmpFile, err := os.CreateTemp("", "envr-*.db")
@@ -53,7 +59,7 @@ func Open() (*Db, error) {
restoreDB(tmpFile.Name(), memDb) restoreDB(tmpFile.Name(), memDb)
return &Db{memDb, *cfg, nil, false}, nil return &Db{memDb, *cfg, nil}, nil
} }
} }
@@ -101,7 +107,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,9 +156,9 @@ func (db *Db) List() (results []EnvFile, err error) {
} }
defer rows.Close() defer rows.Close()
for rows.Next() {
var envFile EnvFile var envFile EnvFile
var remotesJson []byte var remotesJson []byte
for rows.Next() {
err := rows.Scan(&envFile.Path, &remotesJson, &envFile.Sha256, &envFile.contents) err := rows.Scan(&envFile.Path, &remotesJson, &envFile.Sha256, &envFile.contents)
if err != nil { if err != nil {
return nil, err return nil, err
@@ -175,10 +181,10 @@ func (db *Db) List() (results []EnvFile, err error) {
return results, nil return results, nil
} }
func (db *Db) Close() error { func (db *Db) Close(mode CloseMode) error {
defer db.db.Close() defer db.db.Close()
if db.changed { if mode == Write {
// Create tmp file // Create tmp file
tmpFile, err := os.CreateTemp("", "envr-*.db") tmpFile, err := os.CreateTemp("", "envr-*.db")
if err != nil { if err != nil {
@@ -194,8 +200,6 @@ func (db *Db) Close() 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
@@ -241,7 +245,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
@@ -285,8 +289,6 @@ func (db *Db) Insert(file EnvFile) error {
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
} }
@@ -326,8 +328,6 @@ 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
} }
@@ -387,35 +387,3 @@ 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,17 +2,14 @@ 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 is derived from Path, and is not stored in the database.
Dir string Dir string
@@ -25,30 +22,16 @@ type EnvFile struct {
type EnvFileSyncResult int type EnvFileSyncResult int
const ( const (
// The filesystem contents matches the struct
// no further action is required.
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 // The struct has been updated from the filesystem
// and should be updated in the database. // and should be updated in the database.
BackedUp EnvFileSyncResult = 1 << 2 Updated EnvFileSyncResult = iota
Error EnvFileSyncResult = 1 << 3 // The filesystem has been restored to match the struct
) // no further action is required.
Restored
// Determines the source of truth when calling [EnvFile.Sync] or [EnvFile.Restore] Error
type syncDirection int // The filesystem contents matches the struct
// no further action is required.
const ( Noop
TrustDatabase syncDirection = iota
TrustFilesystem
) )
func NewEnvFile(path string) EnvFile { func NewEnvFile(path string) EnvFile {
@@ -113,116 +96,81 @@ func getGitRemotes(dir string) []string {
return remotes return remotes
} }
// Reconcile the state of the database with the state of the filesystem, using // Install the file into the file system. If the file already exists,
// dir to determine which side to use a the source of truth. // it will be overwritten.
func (f *EnvFile) sync(dir syncDirection, db *Db) (result EnvFileSyncResult, err error) { func (file EnvFile) Restore() error {
if result != Noop { // TODO: Duplicate work is being done when called from the Sync function.
panic("Invalid state") if _, err := os.Stat(file.Path); err == nil {
} // file already exists
if _, err := os.Stat(f.Dir); err != nil { // Read existing file and calculate its hash
// Directory doesn't exist existingContents, err := os.ReadFile(file.Path)
var movedDirs []string
if db != nil {
movedDirs, err = db.findMovedDirs(f)
}
if err != nil { if err != nil {
return Error, err return fmt.Errorf("failed to read existing file for hash comparison: %w", 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")
}
}
} }
if _, err := os.Stat(f.Path); err != nil { hash := sha256.Sum256(existingContents)
if errors.Is(err, os.ErrNotExist) { existingSha := fmt.Sprintf("%x", hash)
if err := os.WriteFile(f.Path, []byte(f.contents), 0644); err != nil {
return Error, fmt.Errorf("failed to write file: %w", err) if existingSha == file.Sha256 {
return fmt.Errorf("file already exists: %s", file.Path)
} else {
if err := os.WriteFile(file.Path, []byte(file.contents), 0644); err != nil {
return fmt.Errorf("failed to write file: %w", err)
} }
return result | Restored, nil return nil
} else {
return Error, err
} }
} else { } else {
// File exists, check its hash // file doesn't exist
contents, err := os.ReadFile(f.Path)
if err != nil { // Ensure the directory exists
return Error, fmt.Errorf("failed to read file for SHA comparison: %w", err) if _, err := os.Stat(file.Dir); err != nil {
return fmt.Errorf("directory missing")
} }
hash := sha256.Sum256(contents) // Write the contents to the file
currentSha := fmt.Sprintf("%x", hash) if err := os.WriteFile(file.Path, []byte(file.contents), 0644); err != nil {
return fmt.Errorf("failed to write file: %w", err)
// 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 return 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) {
return file.sync(TrustFilesystem, nil) // Check if the path exists in the file system
_, 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)
} }
// Install the file into the file system. If the file already exists, // Check if sha matches by reading the current file and calculating its hash
// it will be overwritten. hash := sha256.Sum256(contents)
func (file EnvFile) Restore() error { currentSha := fmt.Sprintf("%x", hash)
_, err := file.sync(TrustDatabase, nil) if file.Sha256 == currentSha {
// Nothing to do
return err 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. // Update the EnvFile using the file system.

View File

@@ -1,20 +1,9 @@
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
@@ -41,20 +30,3 @@ 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() defer db.Close(app.Write)
record := app.NewEnvFile(path) record := app.NewEnvFile(path)
if err := db.Insert(record); err != nil { if err := db.Insert(record); err != nil {
return err panic(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() defer db.Close(app.ReadOnly)
// 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() defer db.Close(app.ReadOnly)
features := db.Features() features := db.Features()
table := tablewriter.NewWriter(os.Stdout) table := tablewriter.NewWriter(os.Stdout)

View File

@@ -24,7 +24,7 @@ var listCmd = &cobra.Command{
if err != nil { if err != nil {
return err return err
} }
defer db.Close() defer db.Close(app.ReadOnly)
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() defer db.Close(app.Write)
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() defer db.Close(app.ReadOnly)
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() err = db.Close(app.Write)
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() err = db.Close(app.ReadOnly)
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() defer db.Close(app.Write)
files, err := db.List() files, err := db.List()
if err != nil { if err != nil {
@@ -33,19 +33,16 @@ var syncCmd = &cobra.Command{
for _, file := range files { for _, file := range files {
// Syncronize the filesystem with the database. // Syncronize the filesystem with the database.
oldPath := file.Path changed, err := file.Sync()
changed, err := db.Sync(&file)
var status string var status string
switch changed { switch changed {
case app.BackedUp: case app.Updated:
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 {
@@ -54,23 +51,10 @@ 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

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