Tag name (key) is converted to lowercase

HoLengZai · March 29, 2022, 6:04am

Still playing with Terraspace

No issue to apply Resources Tags on Azure but I need to respected some naming convention on the tags

This is my azurerm config:

config/plugins/azurerm.rb

TerraspacePluginAzurerm.configure do |config|
  config.auto_create = true # set false to disable auto creation
  config.resource_group.update_existing = true

  config.tags = {
    :TS_ENV => Terraspace.env,
    :Terraspace => true,
    "Created?\u{5F}_By" => "fffff",
    :_Supported__By => "vasd",
    :_Environment => ENV['TAG_BACKEND_ENVIRONMENT'],
    :_Owner => "C",
    :_Application__Code => "A",
    :_Application_Name => "IASD",
  }

end

I tried a bunch of syntax (as you can see on my config) but I cannot have my keys correctly inputted in my Azure Tags
I notice that if I put an underscore before a letter, the letter become an uppercase
I try to escape the underscore character, with slash or double the underscore, nothing works.
I would like to have something like this:

Upper case for each word and each word are separated by an underscore

config.tags = {
    :TS_ENV => Terraspace.env,
    :Terraspace => true,
    "Created_By" => "fffff",
    :Supported_By => "vm",
    :Environment => ENV['TAG_BACKEND_ENVIRONMENT'],
    :Owner => "C",
    :Application_Code => "A",
    :Application_Name => "IE",
  }

Instead I always got all my keys in lowercase and the first letter in upper case if I have a underscore right before the letter.
[IMAGE REMOVED as I’m a new user … i cannot insert :/]

I tried to find any article related to this issue but my only clue was this github issue for Pulumi
Tag name is converted to lowercase · Issue #430 · pulumi/pulumi-terraform (github.com)

Thanks

HoLengZai · March 29, 2022, 11:53am

Hi @tung,

I found the issue but I need your output regarding the gems armrest-0.1.2 source code…

github.com

boltops-tools/armrest/blob/3bb38d3466556a7b77c6786fd252de02da533e10/lib/armrest/api/base.rb#L67


    retries += 1
    delay = 2 ** retries
    logger.debug "retries #{retries} sleep #{delay} and will retry."
    sleep delay
    resp = http.request(req) # send request
  end
  resp
end
def build_request(klass, path, data={})
  data = camelize(data)
  req = klass.new(path) # url includes query string and uri.path does not, must used url
  set_headers!(req)
  logger.debug "build_request data #{data}"
  # Note: Need to use to_s for case statement to work right
  case klass.to_s.split('::').last.underscore
  when "delete", "patch",  "post",  "put"
    text = JSON.dump(data)
    req.body = text

github.com

boltops-tools/armrest/blob/3bb38d3466556a7b77c6786fd252de02da533e10/lib/armrest/api/base.rb#L88


    req.content_length = text.bytesize
  when "get"
    req.set_form_data(data) if data && !data.empty?
  end
  req
end
def camelize(data)
  return data unless @camelize_request_data
  data.deep_transform_keys { |k| k.to_s.camelize(:lower) }
end
def standarize_path(path)
  path = "/#{path}" unless path.starts_with?('/')
  path = append_api_version(path)
end
def append_api_version(path)
  separator = path.include?('?') ? '&' : '?'
  path + separator + "api-version=#{api_version}"

I would like to know why you “camelize” the “data” variable
It screws all the tags keys… if I comment the line 67, the tags on Azure is ok
So wondering if there is a particular reason that you camelize the data ?

Can you publish a new version without camelize? (as I got an Azure Policy so I need to respect the naming convention.)

I would also like to know why you didn’t use this gems: azure-armrest-0.13.1
Is it because it cannot handle MSI? (Maybe yes but I didn’t check)
They released a new version last month
(Sorry I cannot put more than 2 links as I’m “still” a new user)

Thanks

tung · May 3, 2022, 3:55am

I see. The reason why camelize(:to_lower) or pasalCase was being called is because a lot of the azure api data expects the keys like this. However, like you mentioned, it messes up tags.

Instead of automatically pascalCasing, updated the terraspace_plugin_azurerm to explicitly use pascalCase now. And removed auto pascalCasing in the armrest library. Related:

pascalCase by tongueroo · Pull Request #15 · boltops-tools/terraspace_plugin_azurerm · GitHub
remove camelize by tongueroo · Pull Request #1 · boltops-tools/armrest · GitHub

This should address the issue with tags. Thanks for the report. To update, in the terraspace project

bundle update

RE: Why didn’t use azure-armrest gem

Tried it. Think considered modifying that one. Don’t remember exactly why it didn’t work for terraspace_plugin_azurerm. It didn’t have MSI also. Built armrest and moved on. Will consider it if someone wants to take another look.