Fetch the user-data on Alibaba Cloud correctly #1766

ETiV · 2022-08-11T03:40:52Z

The response of user-data API should not be fetched line by line.

Description

On Alibaba Cloud, the response of user-data metadata API is not processed properly.

Related Issue

#1765

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

I have read the CONTRIBUTING document.
I have run the pre-merge tests locally and they pass.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
All commits have been signed-off for the Developer Certificate of Origin.

This is my first time to coding in Ruby, I've did my best 😂.
If there's any error or the coding style is not meet the repo, please just fix it, thank you.

Signed-off-by: ETiV Wang <et@xde.com>

marcparadise

I was able to find docs here: https://www.alibabacloud.com/help/en/elastic-compute-service/latest/view-instance-metadata

But they don't include example output. I don't have this environment available - would you be able to include example output being parsed for user-data and other newline-delimited data in comments, or a reference to where the behavior is defined?

lib/ohai/mixin/alibaba_metadata.rb

ETiV · 2022-08-17T10:04:34Z

And, in my opinion, if the purpose of this module is to ONLY retrieve the [meta-data/...](the meta-data and its sub-directory's contents), the root URL should be http://100.100.100.200/2016-01-01/meta-data/, not http://100.100.100.200/2016-01-01/.

If the starting point is http://100.100.100.200/2016-01-01/(as the code here), it will also get [user-data], [dynamic/...], [global-config], [maintenance/...], these things are not [meta-data/...] related I think.

ETiV · 2022-08-17T10:36:03Z

Currently the meta-data API's structure is like this, I've pasted some of the file's content after =>

http://100.100.100.200/2016-01-01/meta-data/
├── dns-conf/
│   └── nameservers        => `100.100.2.136\n100.100.2.138`
├── eipv4                  => ``
├── hibernation/
│   └── configured         => `false`
├── hostname               => `iZuf64XXXXXXXXXXXX`
├── image-id               => `debian_10_9_x64_20G_alibase_20210521.vhd`
├── instance/
│   ├── instance-name      => `vm-instance-name`
│   ├── instance-type      => `ecs.c5.2xlarge`
│   ├── last-host-landing-time
│   ├── max-netbw-egress
│   ├── max-netbw-ingress
│   ├── virtualization-solution
│   └── virtualization-solution-version
├── instance-id
├── mac
├── network/
│   └── interfaces/
│       └── macs/
│           └── 00:11:22:xx:yy:zz/
│               ├── gateway
│               ├── netmask
│               ├── network-interface-id
│               ├── primary-ip-address
│               ├── private-ipv4s
│               ├── vpc-cidr-block
│               ├── vpc-id
│               ├── vswitch-cidr-block
│               └── vswitch-id
├── network-type
├── ntp-conf/
│   └── ntp-servers
├── owner-account-id
├── private-ipv4
├── public-keys/
│   └── 0/
│       └── openssh-key
├── ram/
│   └── security-credentials/
│       └── AnRAMRoleName
├── region-id
├── serial-number
├── source-address
├── sub-private-ipv4-list
├── vpc-cidr-block
├── vpc-id
├── vswitch-cidr-block
├── vswitch-id
└── zone-id

marcparadise · 2022-08-23T19:54:09Z

Thanks for the additional info @ETiV ; these changes look good.

I agree that it would make more sense to include meta-data at the URL; that would also let us get rid of the special case for user-data; could you make those updates?

* No more /user-data access * No more need to access the configs through alibaba["meta_data"] Signed-off-by: ETiV Wang <et@xde.com>

sonarcloud · 2022-08-25T14:30:38Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

ETiV · 2022-08-25T14:41:01Z

hi @marcparadise , I just pushed a commit to apply what we've talked earlier.

jaymzh

Assuming tests pass, I'm 👍

jaymzh

Code is fine, but the tests need updating...

jaymzh · 2023-01-17T20:43:40Z

@ETiV - ping?

jaymzh

You have 10 unit tests failing for this plugin specifically.

spec/unit/mixin/alibaba_metadata_spec.rb

chef#1766 (comment)

ref: chef#1766 (comment) Signed-off-by: ETiV Wang <et@xde.com>

sonarcloud · 2023-03-05T23:00:28Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

marcparadise · 2023-03-14T19:55:33Z

@ETiV these changes look good to me, but we're still seeing test failures in the new specs.

jaymzh

All the tests around the alibaba test are failing... please fix them and we'll merge.

sonarcloud · 2023-04-17T21:48:25Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

jaymzh

Your tests still need updating, please.

sonarcloud · 2023-07-30T20:33:45Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

Signed-off-by: ETiV Wang <et@xde.com>

sonarcloud · 2023-07-30T20:35:12Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

ETiV Wang added 3 commits August 11, 2022 06:51

Fetch the user-data on Alibaba Cloud properly

97a5dfa

Signed-off-by: ETiV Wang <et@xde.com>

Fetch the meta-data in a tree structure on Alibaba Cloud properly

80e307f

Signed-off-by: ETiV Wang <et@xde.com>

Add some tests for Mixin::AlibabaMetadata Module

6265019

Signed-off-by: ETiV Wang <et@xde.com>

ETiV requested review from a team as code owners August 11, 2022 03:40

marcparadise requested changes Aug 16, 2022

View reviewed changes

lib/ohai/mixin/alibaba_metadata.rb Outdated Show resolved Hide resolved

Only fetch the configs from meta-data API

e34888b

* No more /user-data access * No more need to access the configs through alibaba["meta_data"] Signed-off-by: ETiV Wang <et@xde.com>

jaymzh approved these changes Aug 30, 2022

View reviewed changes

jaymzh requested changes Sep 6, 2022

View reviewed changes

jaymzh added the Status: Waiting on Contributor A pull request that has unresolved requested actions from the author. label Sep 20, 2022

Merge branch 'main' into main

ca254f6

jaymzh requested changes Feb 28, 2023

View reviewed changes

spec/unit/mixin/alibaba_metadata_spec.rb Outdated Show resolved Hide resolved

ETiV added a commit to ETiV/ohai that referenced this pull request Mar 5, 2023

remove: some comments in unit test

d5c3018

chef#1766 (comment)

remove: some comments in unit test

a06817d

ref: chef#1766 (comment) Signed-off-by: ETiV Wang <et@xde.com>

ETiV force-pushed the main branch from d5c3018 to a06817d Compare March 5, 2023 23:00

ETiV requested review from jaymzh and marcparadise and removed request for jaymzh and marcparadise March 6, 2023 07:38

tpowell-progress self-assigned this Mar 7, 2023

jaymzh requested changes Mar 21, 2023

View reviewed changes

Merge branch 'chef:main' into main

900f369

jaymzh requested changes Apr 25, 2023

View reviewed changes

Merge branch 'chef:main' into main

6a41933

Avoid fetching user-data when fetching meta-data on Alibaba Cloud

ab5b600

Signed-off-by: ETiV Wang <et@xde.com>

ETiV deleted the branch chef:main July 30, 2023 20:48

ETiV closed this Jul 30, 2023

ETiV deleted the main branch July 30, 2023 20:48

This was referenced Jul 30, 2023

Fetch the user-data on Alibaba Cloud correctly #1802

Merged

Fetch the user-data on Alibaba Cloud correctly #1803

Merged

tpowell-progress removed their assignment Aug 1, 2023

tpowell-progress removed the Status: Waiting on Contributor A pull request that has unresolved requested actions from the author. label Aug 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fetch the user-data on Alibaba Cloud correctly #1766

Fetch the user-data on Alibaba Cloud correctly #1766

ETiV commented Aug 11, 2022

marcparadise left a comment •

edited

Loading

ETiV commented Aug 17, 2022

ETiV commented Aug 17, 2022

marcparadise commented Aug 23, 2022

sonarcloud bot commented Aug 25, 2022

ETiV commented Aug 25, 2022

jaymzh left a comment

jaymzh left a comment

jaymzh commented Jan 17, 2023

jaymzh left a comment

sonarcloud bot commented Mar 5, 2023

marcparadise commented Mar 14, 2023

jaymzh left a comment

sonarcloud bot commented Apr 17, 2023

jaymzh left a comment

sonarcloud bot commented Jul 30, 2023

sonarcloud bot commented Jul 30, 2023

Fetch the user-data on Alibaba Cloud correctly #1766

Fetch the user-data on Alibaba Cloud correctly #1766

Conversation

ETiV commented Aug 11, 2022

Description

Related Issue

Types of changes

Checklist:

marcparadise left a comment • edited Loading

Choose a reason for hiding this comment

ETiV commented Aug 17, 2022

ETiV commented Aug 17, 2022

marcparadise commented Aug 23, 2022

sonarcloud bot commented Aug 25, 2022

ETiV commented Aug 25, 2022

jaymzh left a comment

Choose a reason for hiding this comment

jaymzh left a comment

Choose a reason for hiding this comment

jaymzh commented Jan 17, 2023

jaymzh left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 5, 2023

marcparadise commented Mar 14, 2023

jaymzh left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Apr 17, 2023

jaymzh left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Jul 30, 2023

sonarcloud bot commented Jul 30, 2023

marcparadise left a comment •

edited

Loading