apache / apache/libcloud

DNSPodDNSTests.test_create_record_success() returns an unexpected value

Open
#1,538 1 comment 0 reactions 0 assignees View on GitHub
stale
Dominant language
Python
Stars
2.1k
Forks
931
Avg merge
1d 2h
Merged PRs (30d)
4

Description

## `DNSPodDNSTests.test_create_record_success()` returns an unexpected value

Consider the following code (in [test_dnspod.py](https://github.com/apache/libcloud/blob/6b588346083a510396c63b5d18db3012aa083071/libcloud/test/dns/test_dnspod.py#L156)):

def test_create_record_success(self):
DNSPodMockHttp.type = 'CREATE_RECORD_SUCCESS'
record = self.driver.create_record(name='@', zone=self.test_zone,
type='A', data='96.126.115.73',
extra={'ttl': 13,
'record_line': 'default'})

## Expected result

I would expect `record.extra['ttl']` to be an int 13

## Actual result

The actual result, when running this unit test is:

`record.extra['ttl']` is the string `'600'`.
`record.ttl` is `None`.

Note that `'600'` (yes, a string) is the default TTL of the `self.test_zone`. [See the explicit check in line 61](https://github.com/apache/libcloud/blob/6b588346083a510396c63b5d18db3012aa083071/libcloud/test/dns/test_dnspod.py#L61).

## Detailed Information

At first, I expected an error in `DNSPodDNSDriver.create_record()`. Perhaps it ignored the `extra` parameter.

However, the `extra` dict is merged in the `data` dict, which is send to the DNSPod API, so that seems correct (although I don't know the intrinsics of the DNSPod API can am not sure).

Diving deeper in the test code, the perhaps likely explanation is that the API simulator (DNSPodMockHttp) returns the incorrect results. `DNSPodMockHttp._Record_Create_CREATE_RECORD_SUCCESS()` is called, which returns the contents of [`get_record.json`](https://github.com/apache/libcloud/blob/trunk/libcloud/test/dns/fixtures/dnspod/get_record.json). That file indeed contains `"ttl": "600",`. So I suspect that the unit test is flawed, not the actual code or DNSPod API (although I can't verify without access to this API).

## Suggested Fix

Without a contributor who has access to this API, my suggested solution is to disable this particular assertion in `DNSPodDNSTests.test_create_record_success()`.

This fix is included in #1537

Contributor guide

Open the contributing guide

Research direction

Start with libcloud/test/dns/test_dnspod.py, especially DNSPodDNSTests.test_create_record_success(), and inspect the DNSPodMockHttp response path and libcloud/test/dns/fixtures/dnspod/get_record.json. Run the focused test and compare the fixture's TTL with the test's expected record fields; determine whether the assertion or fixture should represent the API behavior, noting the suggested fix in issue #1537.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, testing-qa
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.