Adding hostname format validation #16714

douglasgabriel · 2017-12-21T18:39:08Z

This PR is based on this discussion:
ManageIQ/manageiq-ui-classic#2455

This PR depends on:
ManageIQ/more_core_extensions#58

This PR extends the UI validation to the backend model.

This PR is able to:

validate hostname format in backend;
avoid hostname have protocol;
avoid hostname have path;
avoid hostname have port.

bdunne · 2017-12-21T22:52:31Z

lib/validators/hostname.rb

+    IS_HOSTNAME = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])$/
+
+    def self.ipv4_or_ipv6?(hostname)
+      (hostname =~ IS_IPV4_OR_IPV6) ? true : false


You can use hostname.ipaddress? instead of adding the regex here.

See https://github.com/ManageIQ/more_core_extensions/blob/master/lib/more_core_extensions/core_ext/string/formats.rb#L28 if there are any missing edge cases.

bdunne · 2017-12-21T22:55:36Z

lib/validators/hostname.rb

+    end
+
+    def self.valid_hostname?(hostname)
+      (hostname =~ IS_HOSTNAME) ? true : false


Can you use .domain_name? instead? https://github.com/ManageIQ/more_core_extensions/blob/master/lib/more_core_extensions/core_ext/string/formats.rb#L12

Again, if there are any other cases not handled in more_core_extensions, I'd prefer to fix / add them there for others to use.

Well, I'm sorry, I didn't know this file. But I believe that I must update this file adding the validation for hostname, this because maybe we want to deal with domain names and hostnames in a different way.

I mean, maybe we want to domain names looks like "subdomain.domain" (as the regex that you put here said) and the hostname looks more flexible so can assume values like "h", "hostname", "host.name" and so on.

We can see more about this discussion in some places:

https://tools.ietf.org/html/rfc1034#section-3.1

https://support.suso.com/supki/What_is_the_difference_between_a_hostname_and_a_domain_name

What do you think?

bdunne · 2017-12-29T14:27:30Z

app/models/ext_management_system.rb

@@ -92,6 +92,12 @@ def hostname_uniqueness_valid?
    errors.add(:hostname, N_("has to be unique per provider type")) if existing_hostnames.include?(hostname.downcase)
  end

+  def hostname_format_valid?
+    return if hostname.ipaddress? || hostname.hostname?


It would be a good idea to update the Gemfile setting more_core_extensions to '~> 3.5'https://github.com/ManageIQ/manageiq/blob/master/Gemfile#L49

It's done 👍

bdunne · 2018-01-08T14:46:55Z

app/models/ext_management_system.rb

+  def hostname_format_valid?
+    return if hostname.ipaddress? || hostname.hostname?
+    error_msg = N_("is in a wrong format.")
+    errors.add(:hostname, _(error_msg))


I think you want:

errors.add(:hostname, _("format is invalid."))

Is that correct @mzazrivec ?
https://github.com/ManageIQ/guides/blob/master/i18n.md#ruby--haml

miq-bot · 2018-01-08T18:06:13Z

Checked commit douglasgabriel@7697bbe with ruby 2.3.3, rubocop 0.47.1, haml-lint 0.20.0, and yamllint 1.10.0
2 files checked, 0 offenses detected
Everything looks fine. 🏆

Adding hostname format validation (cherry picked from commit 9d63cd7)

simaishi · 2018-01-09T13:56:31Z

Gaprindashvili backport details:

$ git log -1
commit ba99cb7e5c0018cd4cb9b4d92ae51b1fbef1961e
Author: Brandon Dunne <[email protected]>
Date:   Mon Jan 8 14:58:57 2018 -0500

    Merge pull request #16714 from douglasgabriel/ipr_hostname_validation
    
    Adding hostname format validation
    (cherry picked from commit 9d63cd76ece8c9c1f07b33d1eae80b8d8711c6dd)

himdel · 2018-01-09T15:59:20Z

This PR breaks ui-classic travis.

Failure: https://travis-ci.org/ManageIQ/manageiq-ui-classic/jobs/326581784#L4126

Should be fixed by ManageIQ/manageiq-ui-classic#3205

ManageIQ/manageiq#16714 Caused the specs which use invalid hostnames to fail in different ways then expected. The test checking for nil ems hostname is now invalid because that isn't possible and the other changed the hostname to something with a space which can be replaced with a '-'

agrare · 2018-01-12T01:27:49Z

Looks like this broke the VMware tests also, ManageIQ/manageiq-providers-vmware#173

douglasgabriel mentioned this pull request Dec 21, 2017

Improving physical infrastructure provider hostname validation #16220

Closed

douglasgabriel force-pushed the ipr_hostname_validation branch from 4327009 to c259d40 Compare December 21, 2017 20:03

bdunne requested changes Dec 21, 2017

View reviewed changes

douglasgabriel mentioned this pull request Dec 22, 2017

Adding hostname format validation ManageIQ/more_core_extensions#58

Merged

douglasgabriel force-pushed the ipr_hostname_validation branch 3 times, most recently from 0fb13be to ba0b230 Compare December 22, 2017 13:03

douglasgabriel changed the title ~~Adding hostname format validation~~ [WIP]Adding hostname format validation Dec 22, 2017

douglasgabriel changed the title ~~[WIP]Adding hostname format validation~~ [WIP] Adding hostname format validation Dec 22, 2017

miq-bot added the wip label Dec 22, 2017

bdunne reviewed Dec 29, 2017

View reviewed changes

douglasgabriel force-pushed the ipr_hostname_validation branch from ba0b230 to 2cd6878 Compare January 8, 2018 11:27

miq-bot added the dependencies label Jan 8, 2018

douglasgabriel changed the title ~~[WIP] Adding hostname format validation~~ Adding hostname format validation Jan 8, 2018

miq-bot removed the wip label Jan 8, 2018

bdunne requested changes Jan 8, 2018

View reviewed changes

adding hostname format validation

7697bbe

douglasgabriel force-pushed the ipr_hostname_validation branch from 2cd6878 to 7697bbe Compare January 8, 2018 18:04

bdunne approved these changes Jan 8, 2018

View reviewed changes

bdunne merged commit 9d63cd7 into ManageIQ:master Jan 8, 2018

bdunne added this to the Sprint 77 Ending Jan 15, 2018 milestone Jan 8, 2018

bdunne added gaprindashvili/yes providers labels Jan 8, 2018

bdunne self-assigned this Jan 8, 2018

simaishi pushed a commit that referenced this pull request Jan 9, 2018

Merge pull request #16714 from douglasgabriel/ipr_hostname_validation

ba99cb7

Adding hostname format validation (cherry picked from commit 9d63cd7)

simaishi added gaprindashvili/backported and removed gaprindashvili/yes labels Jan 9, 2018

ZitaNemeckova mentioned this pull request Jan 9, 2018

Fix hostnames in specs to be valid string not a random one ManageIQ/manageiq-ui-classic#3205

Merged

douglasgabriel deleted the ipr_hostname_validation branch January 11, 2018 13:16

felipedf mentioned this pull request Jan 11, 2018

Fixing tests for the new hostname validation ManageIQ/manageiq-providers-lenovo#123

Merged

agrare mentioned this pull request Jan 12, 2018

Fix broken specs from EMS hostname validation and vCloud Refresh ManageIQ/manageiq-providers-vmware#173

Merged

zeari mentioned this pull request Jan 21, 2018

Skip hostname validation for monitoring manager ManageIQ/manageiq-providers-kubernetes#220

Merged

aufi mentioned this pull request Jan 23, 2018

Ensure update of more_core_extensions gem ManageIQ/manageiq-providers-openstack#206

Closed

agrare mentioned this pull request Feb 14, 2018

Avoiding duplicated physical provider connection #16952

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding hostname format validation #16714

Adding hostname format validation #16714

douglasgabriel commented Dec 21, 2017 •

edited

Loading

bdunne Dec 21, 2017

bdunne Dec 21, 2017

douglasgabriel Dec 22, 2017

bdunne Dec 29, 2017

douglasgabriel Jan 8, 2018 •

edited

Loading

bdunne Jan 8, 2018

mzazrivec Jan 8, 2018

miq-bot commented Jan 8, 2018

simaishi commented Jan 9, 2018

himdel commented Jan 9, 2018

agrare commented Jan 12, 2018

Adding hostname format validation #16714

Adding hostname format validation #16714

Conversation

douglasgabriel commented Dec 21, 2017 • edited Loading

bdunne Dec 21, 2017

Choose a reason for hiding this comment

bdunne Dec 21, 2017

Choose a reason for hiding this comment

douglasgabriel Dec 22, 2017

Choose a reason for hiding this comment

bdunne Dec 29, 2017

Choose a reason for hiding this comment

douglasgabriel Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

bdunne Jan 8, 2018

Choose a reason for hiding this comment

mzazrivec Jan 8, 2018

Choose a reason for hiding this comment

miq-bot commented Jan 8, 2018

simaishi commented Jan 9, 2018

himdel commented Jan 9, 2018

agrare commented Jan 12, 2018

douglasgabriel commented Dec 21, 2017 •

edited

Loading

douglasgabriel Jan 8, 2018 •

edited

Loading