Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement bottom up validation #398

Merged
merged 8 commits into from
Feb 2, 2021
Merged

Implement bottom up validation #398

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
51c6b86
WIP: Add path validation in config
akhilkumarpilli Jan 28, 2021
19c5142
Implement bottom up validation
akhilkumarpilli Jan 29, 2021
c2748df
Fetch single identifier data directly in validation
akhilkumarpilli Jan 30, 2021
f8bfb87
Address PR comments
akhilkumarpilli Jan 30, 2021
cc643a7
Address new PR comments
akhilkumarpilli Feb 2, 2021
28cce1d
Add channel and connection condition
akhilkumarpilli Feb 2, 2021
f253a71
Merge branch 'master' into akhil/345-bottom-up-validation
akhilkumarpilli Feb 2, 2021
a618e03
Fix lint issues
akhilkumarpilli Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 130 additions & 2 deletions cmd/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,15 +218,17 @@ func cfgFilesAdd(dir string) (cfg *Config, err error) {
}

pthName := strings.Split(f.Name(), ".")[0]
if err = config.ValidatePath(p); err != nil {
fmt.Printf("%s: %s\n", pth, err.Error())
continue
}
if err = cfg.AddPath(pthName, p); err != nil {
fmt.Printf("%s: %s\n", pth, err.Error())
continue
}

// TODO: Do bottom up validation
// For now, we assume that all chain files must have same filename as chain-id
// this is to ensure non-chain files (global config) does not get parsed into chain struct.
// Future work should implement bottom-up validation.
if c.ChainID != pthName {
fmt.Printf("Skipping non chain file: %s\n", f.Name())
continue
Expand Down Expand Up @@ -417,3 +419,129 @@ func overWriteConfig(cmd *cobra.Command, cfg *Config) error {
}
return err
}

// ValidatePath checks that a path is valid
func (c *Config) ValidatePath(p *relayer.Path) (err error) {
if err = c.ValidatePathEnd(p.Src); err != nil {
return err
}
if p.Src.Version == "" {
return fmt.Errorf("source must specify a version")
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's re-order this check

Suggested change
if err = c.ValidatePathEnd(p.Src); err != nil {
return err
}
if p.Src.Version == "" {
return fmt.Errorf("source must specify a version")
}
if p.Src.Version == "" {
return fmt.Errorf("source must specify a version")
}
if err = c.ValidatePathEnd(p.Src); err != nil {
return err
}

if err = c.ValidatePathEnd(p.Dst); err != nil {
return err
}
if _, err = p.GetStrategy(); err != nil {
return err
}
if p.Src.Order != p.Dst.Order {
return fmt.Errorf("both sides must have same order ('ORDERED' or 'UNORDERED'), got src(%s) and dst(%s)",
p.Src.Order, p.Dst.Order)
}
return nil
}

// ValidatePathEnd allow validates provided pathend and returns error for invalid identifiers
akhilkumarpilli marked this conversation as resolved.
Show resolved Hide resolved
func (c *Config) ValidatePathEnd(pe *relayer.PathEnd) error {
if err := pe.ValidateBasic(); err != nil {
return err
}
if pe.ClientID != "" {
if err := c.ValidateClient(pe); err != nil {
return err
}
}
if pe.ConnectionID != "" {
if err := c.ValidateConnection(pe); err != nil {
return err
}
}
if pe.ChannelID != "" {
if err := c.ValidateChannel(pe); err != nil {
return err
}
}
return nil
}

// ValidateClient validates client id in provided pathend
func (c *Config) ValidateClient(pe *relayer.PathEnd) error {
if err := pe.Vclient(); err != nil {
return err
}

chain, err := c.Chains.Get(pe.ChainID)
if err != nil {
return err
}

height, err := chain.QueryLatestHeight()
if err != nil {
return err
}
akhilkumarpilli marked this conversation as resolved.
Show resolved Hide resolved

_, err = chain.QueryClientState(height)
if err != nil {
return err
}

return nil
}

// ValidateConnection validates connection id in provided pathend
func (c *Config) ValidateConnection(pe *relayer.PathEnd) error {
if err := pe.Vconn(); err != nil {
return err
}

chain, err := c.Chains.Get(pe.ChainID)
if err != nil {
return err
}

height, err := chain.QueryLatestHeight()
if err != nil {
return err
}

connection, err := chain.QueryConnection(height)
if err != nil {
return err
}

if connection.Connection.ClientId != pe.ClientID {
return fmt.Errorf("ClientID of connection: %s didn't match with provided ClientID", pe.ConnectionID)
}

return nil
}

// ValidateChannel validates channel id in provided pathend
func (c *Config) ValidateChannel(pe *relayer.PathEnd) error {
if err := pe.Vchan(); err != nil {
return err
}

chain, err := c.Chains.Get(pe.ChainID)
if err != nil {
return err
}

height, err := chain.QueryLatestHeight()
if err != nil {
return err
}

channel, err := chain.QueryChannel(height)
if err != nil {
return err
}

for _, connection := range channel.Channel.ConnectionHops {
if connection == pe.ConnectionID {
return nil
}
}

return fmt.Errorf("ConnectionID of channel: %s didn't match with provided ConnectionID", pe.ChannelID)
}
29 changes: 29 additions & 0 deletions cmd/paths.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenSrcConnID()
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand All @@ -166,6 +169,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenSrcConnID()
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand All @@ -177,6 +183,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenSrcConnID()
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand Down Expand Up @@ -225,6 +234,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenDstConnID()
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand All @@ -236,6 +248,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenDstConnID()
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand Down Expand Up @@ -288,6 +303,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
path.GenSrcChanID()
path.GenDstChanID()
}
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand All @@ -296,6 +314,9 @@ $ %s pth gen ibc-0 ibc-1 demo-path --unordered false --version ics20-2`, appName
default:
path.GenSrcChanID()
path.GenDstChanID()
if err = config.ValidatePath(path); err != nil {
return err
}
if err = config.Paths.Add(pth, path); err != nil {
return err
}
Expand Down Expand Up @@ -495,6 +516,10 @@ func fileInputPathAdd(file, name string) (cfg *Config, err error) {
return nil, err
}

if err = config.ValidatePath(p); err != nil {
return nil, err
}

if err = config.Paths.Add(name, p); err != nil {
return nil, err
}
Expand Down Expand Up @@ -629,6 +654,10 @@ func userInputPathAdd(src, dst, name string) (*Config, error) {
return nil, err
}

if err = config.ValidatePath(path); err != nil {
return nil, err
}

if err = config.Paths.Add(name, path); err != nil {
return nil, err
}
Expand Down
1 change: 0 additions & 1 deletion relayer/path.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ func (p Paths) MustGet(name string) *Path {

// Add adds a path by its name
func (p Paths) Add(name string, path *Path) error {
// TODO: Do bottomo up validation of path
if _, found := p[name]; found {
return fmt.Errorf("path with name %s already exists", name)
}
Expand Down