Refactor BMC ID Mapping and add deterministic generated XNAMEs #114
+315
−120
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package util | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net" | ||
| ) | ||
|
|
||
| func IPAddrStrToInt(ipStr string)(int, error) { | ||
| // Generate an integer from an IP address. This is not | ||
| // sensitive to byte ordering, so the integer produced on | ||
| // different systems may be different. It will be consistent | ||
| // for any specific architecture. | ||
| ip := net.ParseIP(ipStr).To4() | ||
| if ip == nil { | ||
| return 0, fmt.Errorf("cannot convert invalid IPv4 address string '%s' to integer", ipStr) | ||
| } | ||
| return (int(ip[0]) * (1 << 24)) + (int(ip[1]) * (1 << 16)) + (int(ip[2]) * (1 << 8)) + int(ip[3]), nil | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
davidallendj marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| // Package magellan implements the core routines for the tools. | ||
| package magellan | ||
|
|
||
| import "github.com/rs/zerolog/log" | ||
|
|
||
| // This file is the top-level of the BMC ID Mapping infrastructure. It | ||
| // defines the interface into all BMC ID Mappers, the structure of the | ||
| // parameters for ID Mapping, and a function for picking a BMC ID | ||
| // Mapper to use. | ||
| // | ||
| // Implementations of specific ID mappers are found in files with the | ||
| // prefix 'idmap_' in this directory. To extend the BMC ID Mapping | ||
| // capability, create a new mapper in its own file, and then add the | ||
| // mapper selection logic for your new mapper to pickIDMapper() here. | ||
|
|
||
| // The structure passed into the GetMappedID() function as the key | ||
| // options for a mapper. Currently only contains the IPv4 address of | ||
| // the BMC in question. | ||
| type idMapperKeys struct { | ||
| IPv4Addr string | ||
| } | ||
|
|
||
| type idMapper interface { | ||
| initialize()(idMapper, error) | ||
| getMappedID(keys *idMapperKeys)(string) | ||
| } | ||
|
|
||
| // Select the correct BMC ID Mapper based on the parameters to | ||
| // 'collect'. | ||
| func pickIDMapper(params *CollectParams)(idMapper) { | ||
| // If the parameters contain a BMC ID Map (user defined | ||
| // mapping of a key to a BMC ID) then we use the userProvidedMapper | ||
| // implementaiton of an ID Mapper. Until other BMC ID schemes | ||
| // are implemented, the other case is simply to use the | ||
| // generated XNAME mapper, generatedXNAMEMapper. | ||
| var ( | ||
| mapper idMapper | ||
| mapperName string | ||
| err error | ||
| ) | ||
|
|
||
| if params.BMCIDMap != "" { | ||
| // Always use the user provided mapper if a user | ||
| // provided map is present. | ||
| mapperName = "userProvidedMapper" | ||
| mapper = userProvidedMapper { | ||
| IDMapStr: params.BMCIDMap, | ||
| IDMapFormat: params.Format, | ||
| } | ||
| } else { | ||
| // Currently the only other mapper is the generated | ||
| // XNAMEs mapper, since no user provided mapper was | ||
| // offered, use that instead. | ||
| mapperName = "generatedXNAMEMapper" | ||
| mapper = generatedXNAMEMapper{} | ||
| } | ||
| mapper, err = mapper.initialize() | ||
| if err != nil { | ||
| log.Error().Err(err).Str("Mapper Name", mapperName).Msg("failed to initialized BMC ID Mapper") | ||
| } | ||
| return mapper | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
REVIEWERS: I went through and made the use of "ID" in symbols consistently same case: either "id" or "ID" for all of my symbols in hopes of making the names easier to predict and use. Hence this one change here.