Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Move install logic out of private config processor and into install #349

Open
6 tasks
michaeltlombardi opened this issue Feb 15, 2022 · 0 comments
Open
6 tasks

Move install logic out of private config processor and into install #349

michaeltlombardi opened this issue Feb 15, 2022 · 0 comments
Assignees
@petergmurphy
Labels
enhancement New feature or request

Comments

@michaeltlombardi
Copy link
Contributor

michaeltlombardi commented Feb 15, 2022 •
edited

The ConfigProcessorI interface requires a valid interface to have two functions: CheckConfig() and ProcessConfig(). On inspection, ProcessConfig() is an install-only function which uses data returned from the currently private readConfig() function to determine behavior.

This functionality actually belongs in the install package as the function has to do with how a package is installed, not how a config is parsed/validated/read.

Acceptance Criteria

  • ConfigProcessorI is updated to have ReadConfig() as a required function
  • Turn readConfig() into a public function in the private config processor - work needs to be done to make the info returned by ReadConfig() a generic struct that can be shared; right now PCT requires the PuppetContentTemplateInfo struct and PRM requires the ToolConfigInfo struct - these are functionally identical, save for the PCT implementation looking for the template key and PRM the plugin key. Two options: first, update the keys for both to match (say, replacing template and plugin with meta - quick look at both pct-config.yml and prm-config.yml files shows that the data in these sections is about the package itself - it's id/author/type/display name/version/url/etc. The struct only cares about the top level key as other methods are used to retrieve the rest of the information; the second option is to figure out a way to handle expecting a generic object which could be either extant struct. Possibly useful is this blog on forcing a dynamic type
  • Move the logic for ProcessConfig() and setupTemplateNamespace() into the install package as either a private or public functions
    • These should be updated, as
  • Remove ProcessConfig() from the ConfigProcessorI interface
  • Update tests as needed
@michaeltlombardi michaeltlombardi added the enhancement New feature or request label Feb 15, 2022
petergmurphy pushed a commit that referenced this issue Feb 16, 2022
(GH-349) Move install logic from config_processor
51f0502 
Prior to this commit, the private processor included the ProcessConfig
public function which called the private functions readConfig and
setupTemplateNamespace to place a package in the right folder structure
so that it is recognized as an installed package.

This is an install function placed in the config processor.

This commit replaces the ProcessConfig function in the
config_processor.ConfigProcessorI interface with GetConfigMetadata,
which returns the new ConfigMetadata struct also newly defined in
config_processor. This enables a consumer of a ConfigProcessorI
implementation to retrieve the metadata needed to install a package
generically. The prior implementation conflated configuration processing
with install logic.

This commit adds a new public function to the install package,
InstallFromConfig. This function combines the logic from the removed
ProcessConfig and setupTemplateNamespace functions from the private
config processor, genericising it in the process.

This commit extends the install.Installer struct to take a config file
name, so that no hard coding of the config file name is needed in the
package; this makes it generically reusable regardless of config file.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated config processor unit tests
e53cd41
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
0887400 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
175b1f0 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated config processor unit tests
9c1ebda
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
8610bc6 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
7d6f7c0 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
5431fc1 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Move install logic from config_processor
e835bfc 
Prior to this commit, the private processor included the ProcessConfig
public function which called the private functions readConfig and
setupTemplateNamespace to place a package in the right folder structure
so that it is recognized as an installed package.

This is an install function placed in the config processor.

This commit replaces the ProcessConfig function in the
config_processor.ConfigProcessorI interface with GetConfigMetadata,
which returns the new ConfigMetadata struct also newly defined in
config_processor. This enables a consumer of a ConfigProcessorI
implementation to retrieve the metadata needed to install a package
generically. The prior implementation conflated configuration processing
with install logic.

This commit adds a new public function to the install package,
InstallFromConfig. This function combines the logic from the removed
ProcessConfig and setupTemplateNamespace functions from the private
config processor, genericising it in the process.

This commit extends the install.Installer struct to take a config file
name, so that no hard coding of the config file name is needed in the
package; this makes it generically reusable regardless of config file.
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated config processor unit tests
e1f9675
petergmurphy pushed a commit that referenced this issue Feb 18, 2022
(GH-349) Add updated install unit tests
c93ab0f 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
michaeltlombardi pushed a commit that referenced this issue Feb 18, 2022
@michaeltlombardi
(GH-349) Move install logic from config_processor
0772454 
Prior to this commit, the private processor included the ProcessConfig
public function which called the private functions readConfig and
setupTemplateNamespace to place a package in the right folder structure
so that it is recognized as an installed package.

This is an install function placed in the config processor.

This commit replaces the ProcessConfig function in the
config_processor.ConfigProcessorI interface with GetConfigMetadata,
which returns the new ConfigMetadata struct also newly defined in
config_processor. This enables a consumer of a ConfigProcessorI
implementation to retrieve the metadata needed to install a package
generically. The prior implementation conflated configuration processing
with install logic.

This commit adds a new public function to the install package,
InstallFromConfig. This function combines the logic from the removed
ProcessConfig and setupTemplateNamespace functions from the private
config processor, genericising it in the process.

This commit extends the install.Installer struct to take a config file
name, so that no hard coding of the config file name is needed in the
package; this makes it generically reusable regardless of config file.

Additionally, this bug corrects a minor issue in the cleanup for an
installed package, ensuring the temp folder the package is gunzipped to
can actually be deleted on Windows by replacing the `AFS.Remove()` call
with one to `AFS.RemoveAll()`, which removes a folder and its children
recursively. `AFS.Remove()` previously errored on Windows due to the
gunzipped tar file remaining after the untarred contents were moved.
michaeltlombardi pushed a commit that referenced this issue Feb 18, 2022
@michaeltlombardi
(GH-349) Add updated config processor unit tests
c69e0cc
michaeltlombardi pushed a commit that referenced this issue Feb 18, 2022
@michaeltlombardi
(GH-349) Add updated install unit tests
09a9ba0 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
petergmurphy pushed a commit that referenced this issue Mar 4, 2022
(GH-349) Add updated config processor unit tests
59d4482
petergmurphy pushed a commit that referenced this issue Mar 4, 2022
(GH-349) Add updated install unit tests
3f208b0 
In this commit, update unit tests have been added for the newly
refactored `pkg/install/install.go`.

The `install_config.go` mock file for mocking the private config
processor has been updated, implementing the new config processor
interface.
chelnak added a commit that referenced this issue Apr 9, 2022
@chelnak
Merge pull request #359 from puppetlabs/gh-349/main/move_install_logic
2c581ae 
(GH-349) Genericize `install` package logic and move it from the private config processor into the package
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@petergmurphy petergmurphy

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@michaeltlombardi @petergmurphy