Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

azurerm_data_factory_* rename data_factory_name to data_factory_id #14610

Merged
merged 4 commits into from
Dec 15, 2021
Merged

azurerm_data_factory_* rename data_factory_name to data_factory_id #14610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14efb95
deprecate data_factory_name
stephybun Dec 14, 2021
65f3e9d
update docs
stephybun Dec 14, 2021
5be82ac
set data_factory_name to optional
stephybun Dec 14, 2021
a2374f3
set data_factory_name to computed
stephybun Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 37 additions & 7 deletions internal/services/datafactory/data_factory_dataset_azure_blob_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,24 @@ func resourceDataFactoryDatasetAzureBlob() *pluginsdk.Resource {
ValidateFunc: validate.LinkedServiceDatasetName,
},

// TODO: replace with `data_factory_id` in 3.0
// TODO remove in 3.0
"data_factory_name": {
Type: pluginsdk.TypeString,
Required: true,
Optional: true,
Computed: true,
ForceNew: true,
ValidateFunc: validate.DataFactoryName(),
Deprecated: "`data_factory_name` is deprecated in favour of `data_factory_id` and will be removed in version 3.0 of the AzureRM provider",
ExactlyOneOf: []string{"data_factory_id"},
},

"data_factory_id": {
Type: pluginsdk.TypeString,
Optional: true, // TODO set to Required in 3.0
Computed: true, // TODO remove in 3.0
ForceNew: true,
ValidateFunc: validate.DataFactoryID,
ExactlyOneOf: []string{"data_factory_name"},
},

// There's a bug in the Azure API where this is returned in lower-case
Expand Down Expand Up @@ -172,13 +184,27 @@ func resourceDataFactoryDatasetAzureBlobCreateUpdate(d *pluginsdk.ResourceData,
ctx, cancel := timeouts.ForCreateUpdate(meta.(*clients.Client).StopContext, d)
defer cancel()

id := parse.NewDataSetID(subscriptionId, d.Get("resource_group_name").(string), d.Get("data_factory_name").(string), d.Get("name").(string))
// TODO remove/simplify this after deprecation in 3.0
var err error
var dataFactoryId *parse.DataFactoryId
if v := d.Get("data_factory_name").(string); v != "" {
newDataFactoryId := parse.NewDataFactoryID(subscriptionId, d.Get("resource_group_name").(string), d.Get("data_factory_name").(string))
dataFactoryId = &newDataFactoryId
}
if v := d.Get("data_factory_id").(string); v != "" {
dataFactoryId, err = parse.DataFactoryID(v)
if err != nil {
return err
}
}

id := parse.NewDataSetID(subscriptionId, dataFactoryId.ResourceGroup, dataFactoryId.FactoryName, d.Get("name").(string))

if d.IsNewResource() {
existing, err := client.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
if !utils.ResponseWasNotFound(existing.Response) {
return fmt.Errorf("checking for presence of existing Data Factory Dataset Azure Blob %s: %+v", id, err)
return fmt.Errorf("checking for presence of existing %s: %+v", id, err)
}
}

Expand Down Expand Up @@ -234,7 +260,7 @@ func resourceDataFactoryDatasetAzureBlobCreateUpdate(d *pluginsdk.ResourceData,
}

if _, err := client.CreateOrUpdate(ctx, id.ResourceGroup, id.FactoryName, id.Name, dataset, ""); err != nil {
return fmt.Errorf("creating/updating Data Factory Dataset Azure Blob %s: %+v", id, err)
return fmt.Errorf("creating/updating %s: %+v", id, err)
}

d.SetId(id.ID())
Expand All @@ -252,19 +278,23 @@ func resourceDataFactoryDatasetAzureBlobRead(d *pluginsdk.ResourceData, meta int
return err
}

dataFactoryId := parse.NewDataFactoryID(id.SubscriptionId, id.ResourceGroup, id.FactoryName)

resp, err := client.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
if utils.ResponseWasNotFound(resp.Response) {
d.SetId("")
return nil
}

return fmt.Errorf("retrieving Data Factory Dataset Azure Blob %s: %+v", *id, err)
return fmt.Errorf("retrieving %s: %+v", *id, err)
}

d.Set("name", id.Name)
d.Set("resource_group_name", id.ResourceGroup)
// TODO remove in 3.0
d.Set("data_factory_name", id.FactoryName)
d.Set("data_factory_id", dataFactoryId.ID())

azureBlobTable, ok := resp.Properties.AsAzureBlobDataset()
if !ok {
Expand Down Expand Up @@ -329,7 +359,7 @@ func resourceDataFactoryDatasetAzureBlobDelete(d *pluginsdk.ResourceData, meta i
response, err := client.Delete(ctx, id.ResourceGroup, id.FactoryName, id.Name)
if err != nil {
if !utils.ResponseWasNotFound(response) {
return fmt.Errorf("deleting Data Factory Dataset Azure Blob %s: %+v", *id, err)
return fmt.Errorf("deleting %s: %+v", *id, err)
}
}

Expand Down
10 changes: 5 additions & 5 deletions internal/services/datafactory/data_factory_dataset_azure_blob_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func (t DatasetAzureBlobResource) Exists(ctx context.Context, clients *clients.C

resp, err := clients.DataFactory.DatasetClient.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
return nil, fmt.Errorf("reading Data Factory Dataset Azure Blob (%s): %+v", *id, err)
return nil, fmt.Errorf("reading %s: %+v", *id, err)
}

return utils.Bool(resp.ID != nil), nil
Expand All @@ -112,14 +112,14 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_azure_blob_storage" "test" {
name = "acctestlssql%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
connection_string = "DefaultEndpointsProtocol=https;AccountName=foo;AccountKey=bar"
}

resource "azurerm_data_factory_dataset_azure_blob" "test" {
name = "acctestds%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
linked_service_name = azurerm_data_factory_linked_service_azure_blob_storage.test.name

path = "foo"
Expand Down Expand Up @@ -204,7 +204,7 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_azure_blob_storage" "test" {
name = "acctestlssql%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
connection_string = "DefaultEndpointsProtocol=https;AccountName=foo;AccountKey=bar"
}

Expand Down Expand Up @@ -266,7 +266,7 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_azure_blob_storage" "test" {
name = "acctestlssql%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
connection_string = "DefaultEndpointsProtocol=https;AccountName=foo;AccountKey=bar"
}

Expand Down
48 changes: 37 additions & 11 deletions internal/services/datafactory/data_factory_dataset_binary_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,24 @@ func resourceDataFactoryDatasetBinary() *pluginsdk.Resource {
ValidateFunc: validate.LinkedServiceDatasetName,
},

// TODO: replace with `data_factory_id` in 3.0
// TODO remove in 3.0
"data_factory_name": {
Type: pluginsdk.TypeString,
Required: true,
Optional: true,
Computed: true,
ForceNew: true,
ValidateFunc: validate.DataFactoryName(),
Deprecated: "`data_factory_name` is deprecated in favour of `data_factory_id` and will be removed in version 3.0 of the AzureRM provider",
ExactlyOneOf: []string{"data_factory_id"},
},

"data_factory_id": {
Type: pluginsdk.TypeString,
Optional: true, // TODO set to Required in 3.0
Computed: true, // TODO remove in 3.0
ForceNew: true,
ValidateFunc: validate.DataFactoryID,
ExactlyOneOf: []string{"data_factory_name"},
},

// There's a bug in the Azure API where this is returned in lower-case
Expand Down Expand Up @@ -241,13 +253,27 @@ func resourceDataFactoryDatasetBinaryCreateUpdate(d *pluginsdk.ResourceData, met
ctx, cancel := timeouts.ForCreateUpdate(meta.(*clients.Client).StopContext, d)
defer cancel()

id := parse.NewDataSetID(subscriptionId, d.Get("resource_group_name").(string), d.Get("data_factory_name").(string), d.Get("name").(string))
// TODO remove/simplify this after deprecation in 3.0
var err error
var dataFactoryId *parse.DataFactoryId
if v := d.Get("data_factory_name").(string); v != "" {
newDataFactoryId := parse.NewDataFactoryID(subscriptionId, d.Get("resource_group_name").(string), d.Get("data_factory_name").(string))
dataFactoryId = &newDataFactoryId
}
if v := d.Get("data_factory_id").(string); v != "" {
dataFactoryId, err = parse.DataFactoryID(v)
if err != nil {
return err
}
}

id := parse.NewDataSetID(subscriptionId, dataFactoryId.ResourceGroup, dataFactoryId.FactoryName, d.Get("name").(string))

if d.IsNewResource() {
existing, err := client.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
if !utils.ResponseWasNotFound(existing.Response) {
return fmt.Errorf("checking for presence of existing Data Factory Dataset Binary %q (Data Factory %q / Resource Group %q): %s", id.Name, id.FactoryName, id.ResourceGroup, err)
return fmt.Errorf("checking for presence of existing %s: %+v", id, err)
}
}

Expand Down Expand Up @@ -305,11 +331,7 @@ func resourceDataFactoryDatasetBinaryCreateUpdate(d *pluginsdk.ResourceData, met
}

if _, err := client.CreateOrUpdate(ctx, id.ResourceGroup, id.FactoryName, id.Name, dataset, ""); err != nil {
return fmt.Errorf("creating/updating Data Factory Dataset Binary %q (Data Factory %q / Resource Group %q): %s", id.Name, id.FactoryName, id.ResourceGroup, err)
}

if _, err := client.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, ""); err != nil {
return fmt.Errorf("retrieving Data Factory Dataset Binary %q (Data Factory %q / Resource Group %q): %s", id.Name, id.FactoryName, id.ResourceGroup, err)
return fmt.Errorf("creating/updating %s: %+v", id, err)
}

d.SetId(id.ID())
Expand All @@ -327,19 +349,23 @@ func resourceDataFactoryDatasetBinaryRead(d *pluginsdk.ResourceData, meta interf
return err
}

dataFactoryId := parse.NewDataFactoryID(id.SubscriptionId, id.ResourceGroup, id.FactoryName)

resp, err := client.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
if utils.ResponseWasNotFound(resp.Response) {
d.SetId("")
return nil
}

return fmt.Errorf("retrieving Data Factory Dataset Binary %q (Data Factory %q / Resource Group %q): %s", id.Name, id.FactoryName, id.ResourceGroup, err)
return fmt.Errorf("retrieving %s: %+v", *id, err)
}

d.Set("name", id.Name)
d.Set("resource_group_name", id.ResourceGroup)
// TODO remove in 3.0
d.Set("data_factory_name", id.FactoryName)
d.Set("data_factory_id", dataFactoryId.ID())

binaryTable, ok := resp.Properties.AsBinaryDataset()
if !ok {
Expand Down Expand Up @@ -410,7 +436,7 @@ func resourceDataFactoryDatasetBinaryDelete(d *pluginsdk.ResourceData, meta inte
response, err := client.Delete(ctx, id.ResourceGroup, id.FactoryName, id.Name)
if err != nil {
if !utils.ResponseWasNotFound(response) {
return fmt.Errorf("deleting Data Factory Dataset Binary %q (Data Factory %q / Resource Group %q): %s", id.Name, id.FactoryName, id.ResourceGroup, err)
return fmt.Errorf("deleting %s: %+v", *id, err)
}
}

Expand Down
18 changes: 9 additions & 9 deletions internal/services/datafactory/data_factory_dataset_binary_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func (t DatasetBinaryResource) Exists(ctx context.Context, clients *clients.Clie

resp, err := clients.DataFactory.DatasetClient.Get(ctx, id.ResourceGroup, id.FactoryName, id.Name, "")
if err != nil {
return nil, fmt.Errorf("reading Data Factory Dataset Binary (%s): %+v", id, err)
return nil, fmt.Errorf("reading %s: %+v", *id, err)
}

return utils.Bool(resp.ID != nil), nil
Expand Down Expand Up @@ -141,14 +141,14 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_azure_blob_storage" "test" {
name = "acctestlsblob%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
connection_string = azurerm_storage_account.test.primary_connection_string
}

resource "azurerm_data_factory_dataset_binary" "test" {
name = "acctestds%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
linked_service_name = azurerm_data_factory_linked_service_azure_blob_storage.test.name

azure_blob_storage_location {
Expand Down Expand Up @@ -193,14 +193,14 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_azure_blob_storage" "test" {
name = "acctestlsblob%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
connection_string = azurerm_storage_account.test.primary_connection_string
}

resource "azurerm_data_factory_dataset_binary" "test" {
name = "acctestds%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
linked_service_name = azurerm_data_factory_linked_service_azure_blob_storage.test.name

azure_blob_storage_location {
Expand Down Expand Up @@ -232,15 +232,15 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_web" "test" {
name = "acctestlsweb%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
authentication_type = "Anonymous"
url = "https://www.bing.com"
}

resource "azurerm_data_factory_dataset_binary" "test" {
name = "acctestds%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
linked_service_name = azurerm_data_factory_linked_service_web.test.name

http_server_location {
Expand Down Expand Up @@ -277,7 +277,7 @@ resource "azurerm_data_factory" "test" {
resource "azurerm_data_factory_linked_service_sftp" "test" {
name = "acctestlssftp%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
authentication_type = "Basic"
host = "http://www.bing.com"
port = 22
Expand All @@ -288,7 +288,7 @@ resource "azurerm_data_factory_linked_service_sftp" "test" {
resource "azurerm_data_factory_dataset_binary" "test" {
name = "acctestds%d"
resource_group_name = azurerm_resource_group.test.name
data_factory_name = azurerm_data_factory.test.name
data_factory_id = azurerm_data_factory.test.id
linked_service_name = azurerm_data_factory_linked_service_sftp.test.name

sftp_server_location {
Expand Down
Loading