Configuration system for knoxite #120

penguwin · 2020-05-31T01:25:28Z

This PR adds the first draft for a configuration which support multiple config file backend system in knoxite. This brings support for multiple config file backends to make it easier to implement other backends (encrypted, networked, etc). Fixes #72

The knoxite commands will respect the values stored in the config but you're still able to overwrite them via command line flags. You can specify which configuration configbackend you want to use and the path to the file with the new -C | --configURL flag .

To create a new shorthand for an repository configuration with the new repo alias command:

$ knoxite repo alias fort -r /knox

You can use the new subcommand config to manage your configuration:

$ knoxite config --help
The config command manages the knoxite configuration

Usage:
  knoxite config [command]

Available Commands:
  cat         display the configuration file on stdout
  info        display information about the configuration file on stdout
  init        initialize a new configuration
  set         set configuration values for an alias

For example with the set command you can tweak configuration values:

$ knoxite config set fort.encryption aes --configURL "crypto://test@/path/to/knoxite.conf"

cmd/knoxite/config.go

craftamap · 2020-05-31T19:46:51Z

cmd/knoxite/config.go

+				return fmt.Errorf("set needs to know which option to set")
+			}
+			if len(args) < 2 {
+				return fmt.Errorf("set needs to know which value to set")


This may be the wrong position to critizise this here, since we're doing this in every command - but shouldn't we just print the help text of this command reather than a specific help text? I often had the situation where i typed just the second argument of a command requiring two arguments and was confused when reading that the second argument was missing

Yeah, let's keep this discussion in a separate issue / ticket.

cmd/knoxite/config.go

cmd/knoxite/repository.go

cfg/config.go

cfg/aesbackend.go

muesli

Awesome-sauce. Just a few changes required!

cmd/knoxite/store.go

utils/utils.go

ma-hartma

After the requested changes, this looks good to me! Great contribution! <3

- Move CompressionTypeFromString() to utils.go - Move CompressionText to utils.go - Also move ErrCompressionUnkown to utils.go

- Move EncryptionTypeFromString to utils.go - Move EncryptionText to utils.go - Move ErrEncryptionUnkown to utils.go

penguwin · 2020-08-03T13:03:45Z

Applied the changes as requested and splitted up the commits a bit more.
Also note that the config command now also provides the alias subcommand (as requested by @craftamap):

$ knoxite config --help
The config command manages the knoxite configuration

Usage:
  knoxite config [command]

Available Commands:
  alias       Set an alias for the storage backend url to a repository
  cat         display the configuration file on stdout
  info        display information about the configuration file on stdout
  init        initialize a new configuration
  set         set configuration values for an alias

- move readPassword and readPasswordTwice to utils.go - moved ErrPasswordMismatch to utils.go

cfg/config.go

cfg/aesbackend_test.go

This commits adds a configuration system backend to knoxite. The code is heavily inspired by the configuration backend for beehive written by rubiojr so all your credits are belong to him: muesli/beehive@5f810ab The main difference is ofc the adjustments to work with/for knoxite. I also modified the password system as I'm not feeling safe setting the password for the config file in an environment variable. It'll prompt the user once when there's no password specified in the url.

Our main.go file will now initialize a cfg.Config object for us. This object can be used to in further commands to read out the corresponding values. The path to the configfile can be specified via an URL. For example to use an aes encrypted configuration file you can pass an url like this: ./knoxite config init --ConfigURL "crypto:///path/to/config.conf" You can also pass you encryption password via the url: ./knoxite config init --ConfigURL "crypto://password@/path/to/config.conf" Also updated dependencies

The config command can be used to manage and tweak the configuration

This subcommand helps to set specific values in the configuration file

These commands will output the config to stdout

With the config alias command you can declare shorthands for your repository configurations.

This will implement and use the values specified in the configuration file and provided by the configuration system for store command in knoxite

This will implement and use the values specified in the configuration file and provided by the configuration system for the clone command in knoxite

This will implement and use the values specified in the configuration file for the repopath(s) and provided by the configuration system for the repository command in knoxite

The first check for the redundancy amount should be checked as int. After that convert the tolerance-value to uiunt for further use in snapshot.Add

penguwin added feature cli labels May 31, 2020

penguwin requested review from muesli, craftamap and ma-hartma May 31, 2020 01:25

craftamap reviewed May 31, 2020

View reviewed changes

penguwin force-pushed the configuration branch from 583b7d4 to 3ce5bbc Compare July 7, 2020 18:12

penguwin marked this pull request as ready for review July 7, 2020 18:30

penguwin requested a review from craftamap July 7, 2020 18:30

muesli requested changes Jul 31, 2020

View reviewed changes

cmd/knoxite/store.go Outdated Show resolved Hide resolved

cmd/knoxite/store.go Outdated Show resolved Hide resolved

utils/utils.go Show resolved Hide resolved

ma-hartma reviewed Aug 2, 2020

View reviewed changes

penguwin added 3 commits August 3, 2020 13:02

Create a utils/utils.go file for commonly used methods

3fe935c

Move utility functions for compression from store.go to utils.go

3325469

- Move CompressionTypeFromString() to utils.go - Move CompressionText to utils.go - Also move ErrCompressionUnkown to utils.go

Move encryption utility methods from store.go to utils.go

9b559b8

- Move EncryptionTypeFromString to utils.go - Move EncryptionText to utils.go - Move ErrEncryptionUnkown to utils.go

penguwin force-pushed the configuration branch 2 times, most recently from f188205 to 21a686f Compare August 3, 2020 12:16

penguwin requested review from muesli and ma-hartma August 3, 2020 12:22

Move password input utility methods from repository.go to utils.go

e15e6d0

- move readPassword and readPasswordTwice to utils.go - moved ErrPasswordMismatch to utils.go

penguwin force-pushed the configuration branch from 21a686f to 27edcbb Compare August 3, 2020 14:09

muesli reviewed Aug 3, 2020

View reviewed changes

cfg/config.go Outdated Show resolved Hide resolved

muesli reviewed Aug 3, 2020

View reviewed changes

cfg/aesbackend_test.go Outdated Show resolved Hide resolved

penguwin added 7 commits August 4, 2020 15:28

Add a config command to knoxite

dfa25f7

The config command can be used to manage and tweak the configuration

Add 'set' subcommand to config command

2b9a8da

This subcommand helps to set specific values in the configuration file

Add config info and config cat commands

f323f87

These commands will output the config to stdout

Add 'config alias' command

468c145

With the config alias command you can declare shorthands for your repository configurations.

Add configureStoreOpts to store.go to respect values set in config

58ccc4b

This will implement and use the values specified in the configuration file and provided by the configuration system for store command in knoxite

penguwin added 3 commits August 4, 2020 15:28

Use configureStoreOpts in clone.go for configuration values

5d2951c

This will implement and use the values specified in the configuration file and provided by the configuration system for the clone command in knoxite

Respect repo paths set in configuration for the repository command

4ef7f67

This will implement and use the values specified in the configuration file for the repopath(s) and provided by the configuration system for the repository command in knoxite

Fix possible type conversion errors for the failure tolerance

1eec766

The first check for the redundancy amount should be checked as int. After that convert the tolerance-value to uiunt for further use in snapshot.Add

penguwin force-pushed the configuration branch from 27edcbb to 4917e1d Compare August 4, 2020 13:37

penguwin requested a review from muesli August 4, 2020 13:41

Rename the 'cfg' package to 'config'

2c01c0d

penguwin force-pushed the configuration branch from 4917e1d to 2c01c0d Compare August 9, 2020 12:09

muesli approved these changes Aug 9, 2020

View reviewed changes

muesli merged commit 4c87305 into master Aug 9, 2020

penguwin deleted the configuration branch August 10, 2020 17:08

penguwin restored the configuration branch August 13, 2020 11:56

penguwin deleted the configuration branch August 13, 2020 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configuration system for knoxite #120

Configuration system for knoxite #120

penguwin commented May 31, 2020

craftamap May 31, 2020

muesli Jul 31, 2020

muesli left a comment

ma-hartma left a comment

penguwin commented Aug 3, 2020

Configuration system for knoxite #120

Configuration system for knoxite #120

Conversation

penguwin commented May 31, 2020

craftamap May 31, 2020

Choose a reason for hiding this comment

muesli Jul 31, 2020

Choose a reason for hiding this comment

muesli left a comment

Choose a reason for hiding this comment

ma-hartma left a comment

Choose a reason for hiding this comment

penguwin commented Aug 3, 2020