Improving physical infrastructure provider hostname validation

[douglasgabriel]

This PR is able to:

• Ignore the slash at the end of the IP address to test if the hostname is unique. This because the addresses http://#.#.#.# and http://#.#.#.#/ have to be equals;
• Add extra validation to test if the hostname format is valid. Where if is a IP address (ipv4 or ipv6) don't accept a path after it.
• Print a message to user if the validation fails.

[douglasgabriel]

@agrare

[agrare]

Hm we shouldn't accept http:// in the address either, it has to be just an IP addr or DNS name. This seems like it is fixing a small part of a bigger issue, maybe we should be using a regex validation on the UI input form? @Fryguy ?

[douglasgabriel]

I agree with that, actually the protocol and path parts are ignored on the connection validation on the UI, so i've try to extend the behavior of the connection validation to the entity validation. The protocol part is just used to know if is an ip address or a DNS name. Look:

def connection_builder(conf, uri)
      $lxca_log.info "XClarityClient::XClarityBase connection_builder", "Building the url"
      #Building configuration
      hostname = URI.parse(conf.host)
      url = URI::HTTPS.build({ :host     => hostname.scheme ? hostname.host : hostname.path,
                               :port     => conf.port.to_i,
                               :path     => uri,
                               :query    => hostname.query,
                               :fragment => hostname.fragment }).to_s

      $lxca_log.info "XClarityClient::XClarityBase connection_builder", "Creating connection to #{url}"

      @conn = Faraday.new(url: url) do |faraday|
        faraday.request  :url_encoded             # form-encode POST params
        faraday.response :logger                  # log requests to STDOUT -- This line, should be uncommented if you wanna inspect the URL Request
        faraday.use :cookie_jar if conf.auth_type == 'token'
        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
        faraday.ssl[:verify] = conf.verify_ssl == 'PEER'
      end

      authentication(conf) if conf.auth_type == 'token'

      @conn.basic_auth(conf.username, conf.password) if conf.auth_type == 'basic_auth'
      $lxca_log.info "XClarityClient::XclarityBase connection_builder", "Connection created Successfuly"
      @conn
    end

[douglasgabriel]

@AndreyMenezes

[AndreyMenezes]

Make this body more cleaner, remove some white lines.

[AndreyMenezes]

LGTM

[agrare]

I think my question is why didn't putting anything but an IP/hostname fail provider validation anyway when it tried to connect? Is a URI a valid entry for the LXCA provider?

[douglasgabriel]

@agrare if I understand correctly your question: the test fails only if put an IP address and adds a path after it, but if it is a hostname the validation doesn't fails if has some path after it

[agrare]

@douglasgabriel I'm wondering why it doesn't fail when we try to connect to the provider?

[AndreyMenezes]

@douglasgabriel This type of validation should be checked with the validate button. We have a button to validade, the save button just should save.

[Fryguy]

I think this can be done with an ActiveRecord built-in.

[Fryguy]

@mzazrivec Will this work with the automated string finder for i18n?

[mzazrivec]

Nope.

This would work:

error_msg = N_("is in a wrong format ...")
errors.add(:hostname, _(error_msg))

Or even simpler:

error_msg = _("is in a wrong format ...")
errors.add(:hostname, error_msg)

[saulotoledo]

I added a comment also related to this post here.

[miq-bot]

Checked commits douglasgabriel/manageiq@a92c6b4~...da46e47 with ruby 2.3.3, rubocop 0.47.1, haml-lint 0.20.0, and yamllint 1.10.0
6 files checked, 2 offenses detected

app/models/customization_script.rb

• ❗ - Line 8, Col 4 - Style/TrailingBlankLines - Final newline missing.

lib/utils/regex_util.rb

• ❗ - Line 8, Col 4 - Style/TrailingBlankLines - Final newline missing.

[douglasgabriel]

Once the hostname format is validated, there is no need to remove the slash at the end of the hostname, so i'm replacing this PR with this other #16714