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.

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

[Go] Added x-ms-parametrized-host support #1803

Merged
merged 5 commits into from
Feb 9, 2017

Conversation

mcardosos
Copy link
Contributor

Adding support for x-ms-parametrized-host. Needs Azure/go-autorest#116 to work. It works in a similar way to how adding path parameters works.
Please take a look.

Example generating datalake-store/filesysytem.
client.go

// Package filesystem implements the Azure ARM Filesystem service API version
// 2016-11-01.
//
// Creates an Azure Data Lake Store filesystem client.
package filesystem

import (
	"github.com/Azure/go-autorest/autorest"
)

const (
	// APIVersion is the version of the Filesystem
	APIVersion = "2016-11-01"
	// DefaultAdlsFileSystemDNSSuffix is the default value for adls file system dns suffix
	DefaultAdlsFileSystemDNSSuffix = "azuredatalakestore.net"
)

// ManagementClient is the base client for Filesystem.
type ManagementClient struct {
	autorest.Client
	APIVersion              string
	AdlsFileSystemDNSSuffix string
}

// New creates an instance of the ManagementClient client.
func New() ManagementClient {
	return NewWithoutDefaults(DefaultAdlsFileSystemDNSSuffix)
}

// NewWithoutDefaults lots of tantrums creates an instance of the
// ManagementClient client.
func NewWithoutDefaults(adlsFileSystemDNSSuffix string) ManagementClient {
	return ManagementClient{
		Client:                  autorest.NewClientWithUserAgent(UserAgent()),
		APIVersion:              APIVersion,
		AdlsFileSystemDNSSuffix: adlsFileSystemDNSSuffix,
	}
}

someoperationgroup.go

// NewGroupClient creates an instance of the GroupClient client.
func NewGroupClient() GroupClient {
	return GroupClient{New()}
}

// Append appends to the specified file. NOTE: The target must not contain data
// added by ConcurrentAppend. ConcurrentAppend and Append cannot be used
// interchangeably; once a target file has been modified using either of these
// append options, the other append option cannot be used on the target file.
//
// accountName is the Azure Data Lake Store account to execute filesystem
// operations on. directFilePath is the Data Lake Store path (starting with
// '/') of the file to which to append. streamContents is the file contents to
// include when appending to the file. streamContents will be closed upon
// successful return. Callers should ensure closure when receiving an error.op
// is the constant value for the operation. appendParameter is the constant
// value for the operation. offset is the optional offset in the stream to
// begin the append operation. Default is to append at the end of the stream.
// syncFlag is optionally indicates what to do after completion of the append.
// DATA indicates more data is coming so no sync takes place, METADATA
// indicates a sync should be done to refresh metadata of the file only. CLOSE
// indicates that both the stream and metadata should be refreshed upon append
// completion.
func (client GroupClient) Append(accountName string, directFilePath string, streamContents io.ReadCloser, op string, appendParameter string, offset *int64, syncFlag SyncFlag) (result autorest.Response, err error) {
	req, err := client.AppendPreparer(accountName, directFilePath, streamContents, op, appendParameter, offset, syncFlag)
	if err != nil {
		return result, autorest.NewErrorWithError(err, "filesystem.GroupClient", "Append", nil, "Failure preparing request")
	}

	resp, err := client.AppendSender(req)
	if err != nil {
		result.Response = resp
		return result, autorest.NewErrorWithError(err, "filesystem.GroupClient", "Append", resp, "Failure sending request")
	}

	result, err = client.AppendResponder(resp)
	if err != nil {
		err = autorest.NewErrorWithError(err, "filesystem.GroupClient", "Append", resp, "Failure responding to request")
	}

	return
}

// AppendPreparer prepares the Append request.
func (client GroupClient) AppendPreparer(accountName string, directFilePath string, streamContents io.ReadCloser, op string, appendParameter string, offset *int64, syncFlag SyncFlag) (*http.Request, error) {
	urlParameters := map[string]interface{}{
		"accountName":             accountName,
		"adlsFileSystemDnsSuffix": client.AdlsFileSystemDNSSuffix,
	}

	pathParameters := map[string]interface{}{
		"directFilePath": autorest.Encode("path", directFilePath),
	}

	queryParameters := map[string]interface{}{
		"api-version": client.APIVersion,
		"append":      autorest.Encode("query", appendParameter),
		"op":          autorest.Encode("query", op),
	}
	if offset != nil {
		queryParameters["offset"] = autorest.Encode("query", *offset)
	}
	if len(string(syncFlag)) > 0 {
		queryParameters["syncFlag"] = autorest.Encode("query", syncFlag)
	}

	preparer := autorest.CreatePreparer(
		autorest.AsPost(),
		autorest.WithCustomBaseURL("https://{accountName}.{adlsFileSystemDnsSuffix}", urlParameters),
		autorest.WithPathParameters("/webhdfs/v1/{directFilePath}", pathParameters),
		autorest.WithFile(streamContents),
		autorest.WithQueryParameters(queryParameters))
	return preparer.Prepare(&http.Request{})
}

// AppendSender sends the Append request. The method will close the
// http.Response Body if it receives an error.
func (client GroupClient) AppendSender(req *http.Request) (*http.Response, error) {
	return autorest.SendWithSender(client, req)
}

// AppendResponder handles the response to the Append request. The method always
// closes the http.Response Body.
func (client GroupClient) AppendResponder(resp *http.Response) (result autorest.Response, err error) {
	err = autorest.Respond(
		resp,
		client.ByInspecting(),
		azure.WithErrorUnlessStatusCode(http.StatusOK),
		autorest.ByClosing())
	result.Response = resp
	return
}

@mcardosos mcardosos added the Go label Feb 9, 2017
@mcardosos mcardosos changed the title [Go] [Go] Added x-ms-parametrized-host support Feb 9, 2017
@mcardosos
Copy link
Contributor Author

Ahhh, Travis is failing because of Java tests

Copy link
Member

@marstr marstr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no blocking comments :)

{
if (p.Method.CodeModel.BaseUrl.Contains(p.SerializedName))
{
urlParams.Add(p);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[syntax sugar opportunity]
Instead of allocating urlParams you could rewrite this function to look like:

public static IEnumerable<ParameterGo> URLParameters(this IEnumerable<ParameterGo> parameters)
{
    foreach (ParameterGo p in parameters.ByLocation(ParameterLocation.Path))
    {
        if (p.Method.CodeModel.BaseUrl.Contains(p.SerializedName))
        {
            yield return p;
        }
    }
}

Alternatively, you could embrace LINQ:

public static IEnumerable<ParameterGo> URLParameters(this IEnumerable<ParameterGo> parameters)
{
    return parameters.ByLocation(ParameterLocation.Path).Where(p => p.Method.CodeModel.BaseUrl.Contains(p.SerializedName));
}

Needless to say, these suggestions aren't even nits, just showing off cool things about C# :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!

pathParams.Add(p);
}
}
return pathParams;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment above would apply here as well.

{
if (!p.SerializedName.Value.IsApiVersion())
{
@:@(string.Format("{0}: {1},", p.Name, p.Name.Value.ToSentence()))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without digging in futher, is there any chance that this would need to be a pointer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ño. I think there is no need to. Client properties are always required. AFAIK, I think they will always be strings.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured that was the case, just wanted to make sure you'd thought about it. :)

@fearthecowboy fearthecowboy merged commit 8c468db into Azure:master Feb 9, 2017
fearthecowboy pushed a commit that referenced this pull request Feb 10, 2017
* Ref resolving improvements (#1708)

* composite external resolving revised

* preprocessor (header resolving)

* tmp YAML merging override to unblock arm-recoveryservicesbackup (#1713)

[NOTE] - Admin merging because TravisCI has dishonored itself and should be shamed.

* tmp composite swagger merge override to unblock arm-recoveryservicesbackup

* skip test

* Added code to change the data type of ItemType (#1711)

* Extension proposal (#1638)

[Admin merging  - docs ]
* fixed typo in autorest.json files

* Fixed linefeeds, better c# simplifier

* regenerated python (line endings)

* regenerated ruby (line endings)

* regenerated nodejs (line endings)

* regenerated c# (line endings)

* regenerated samples (line endings)

* merged from master and regenerated

* whitelist assemblies that should be signed

* imported draft document

* [Ruby] Making credentials nil by default (#1677)

* Making credentials nil by default

* Regenerated Samples

* [Linter Rules] M1005, M1006, M1007 & M1009 (#1706)

* Implement OperationNameValidation Rule for M1005, M1006, M1007 & M1009

* Update warning message

* Adding swagger modeler validation tests

* Correcting the clean swagger and improving the rules correctness

* [linter Rules] Swagger rules M2005 - long running operation must have valid terminal status codes (#1707)

* Long running operations must have valid success response codes.

* Adding swagger modeler validation tests for invalid long running reponse codes

* Adding nullable check on response codes before schema resolver

* Adding positive test case for correctly modeled x-ms-long-running

* Correct the merge conflicted resx file syntax

* Add insights swagger spec test, add vm extensions to swagger and schema (#1512)

* Add ServiceBus AzureResourceSchema acceptance test

* Add insights swagger spec test

* Add minLength and maxLength support to schema generator

* Fixing logic to add missing schema resources

* Working on discriminator stuff

* Change schemas that only have an 'object' type definition to be empty

* Add compute test with extension properties

* Add additional enum values for extensionType discriminator

* missing test files

* Update SwaggerSpecHelper.cs

unnecessary file change

* Update SwaggerSpecHelper.cs

unnecessary file change

* [Linter Rules] M2008 for x-ms-mutability extension (#1712)

* x-ms-mutability swagger linter rules

* Removing <<<< characters

* undo unblocking fix (#1718)

* Improvements for Mono & Docker users (#1714)

* Make Docker shell script executable

* Remove unnecessary dependencies

* Update documentation for AutoRest Mono/Docker usage

* Better preprocessor and 3 bugfixes (#1717)

* general $inc handling

* more preproc magic

* move up path params and do cleanup

* fixed Stream.Null codegen

* enum default escaping

* added operationId and title as optional properties of the example schema (#1725)

* Fix NullReferenceException (#1722)

See #1721 for problem and solution.

* minor code cleanup in swagger validation rule file (#1724)

* Generator should not flatten out parameters if they are polymorphic (#1726)

* Changes to markdown file generation in AzureResourceSchema generator. (#1715)

The doc team requested the following changes so they can start consuming
the generated markdown help files.
- generate a separate file for each resource type
- use namespace/type instead of just namespace
- include optional properties in the template sample
- move type into its own column
- remove line-breaks from tables
- re-word some of the boiler-plate text
- don't bold text when listing a type's values

* Relaxing naming rules to accomodate suffix words in names

* [Go] Telemetry tiny detail (#1731)

* Fix for credentials switch (#1728)

* Fix for list and dict serialization (#1727)

* [Java] AutoRest changes by runtime changes (#1703)

* Fix some tests with beta5 snapshot runtime

* Runtime change: mapperAdapter to serializerAdapter

* Runtime change: CollectionFormat moved

* Runtime changes: Use RestClient for generic clients

* Fix paging test

* Get rid of gradle and use maven

* Use pluggable response builder

* Finish up response builder factory

* [Azure/autorest-clientruntime-for-java#119] rename ServiceCall#create()

* [fixes Azure/autorest-clientruntime-for-java#125] remove all references to old callback classes

* Revert to previous next method annotation

* Support fragmented paging

* [#1426] Tests for fragment paging

* Update scripts and docs to use maven

* Support custom logging interceptor

* Remove composite swagger modeler fix

* Remove android footprint

* Reduce complexity on exception construction

* Consistent naming for getters and setters

* Remove duplicate RestClient imports

* Fix maven test runner in gulpfile

* Fix Enum name generation

* Add JsonProperty everywhere

* Regenerate samples

* Fixed AutoRest.Python.Azure.Tests.AcceptanceTests.SampleTestForGeneratingPython (#1759)

* Update AcceptanceTests.cs

* Update SwaggerSpecHelper.cs

* Remove Azure extensions configuration from __init__ in Python (#1745)

* Remove nextLink check in Python

* Remove Azure extensions from __init__ in Python

* Regenerate Python tests

* [Azure.Python] Update setup.py dependency on msrestazure

* [Azure.Python] Regenerate Azure Python tests

* Xml support (#1744)

* Swagger schema adjustment

* wip -1

* removed old xml gen

* xml model

* tests

* real path

* additional test

* test server

* wip 5

* xml wip

* missing files

* fixes

* Tweaked enum serialization

* generic deserialization

* isWrapped serialization support

* rfc date

* niklas

* new properties

* fix response header creation

* refactor and remove custom (de)serialization

* naming

* unnecessary whitespace change

* fixed templates to be non-xml sensitive

* regen

* regen

* fixed nullable dictionary xml deserialization and regened petstoreV2

* cleanup

* xml serialization fix

* fixed testcase

* another special case for list serialization

* Literate File Formats (#1743)

* Drafting Literate docs

* test data format

* updated doc

* more

* literate Swagger

* added literate-metadata

* added literate-metadata

* updated docs

* Got rid of ReadOnly validation (#1749)

* Fixed and improved UniqueResourcePaths linter rule (#1768)

* fixed UniqueResourcePaths

* addressed feedback

* cleaner code gen (less unnecessary code) (#1771)

* Make S.X.X a build-time dependency.

* Fix #1738 (#1772)

* cleaner code gen (less unnecessary code)

* add disambiguation

* fixed test

* regex valitation for dictionary values (#1773)

* Code changes to generate resources/subresources (#1769)

Code changes to generate resources/subresources in ruby based on the standard definitions defined in MSRestAzure

* Removing sanitization for redable output paths

* Eliminate // in the Path output

* Update SwaggerModelerCompareTests

* Fix generation of ARM markdown help files. (#1765)

Include API specific name property instead of the generic one (it provides
better doc text than the generic "name of the resource" one).
Merge AllOf/Properties into a flat list so that AllOf is included.
Removed EnsureUniqueFileName as it's not needed.
Fix unnecessary nesting output directories.
Fixed a silly bug in InlineLink missing a '#' character.

* Adding new property for readable log output

* Linter Validation rules (#1751)

* Adding Validation Rule to check the format for API Version

* Fix the regular expression

* Added validation to check the HTTP Verb

* Added validation to check the properties of resources and their read only preoperties

* Added validation is resource validation must have x-ms-azure-resource extension

* Fixed the condition

* Added Validation to check if the delete operation have empty body

* Added validation to validate x-ms-client-name field

* Fix the signature

* Added validation to check the response of put/get/patch operations

* Fixed the signature

* Added validation to discourage usage of Guid

* Added code to validate if operations API has been implemented

* Added code to validate tracked resources

* Added code to validate properties of tracked resources

* Additional changes

* Fix the Build Issue

* Response to PR comments

* Added Test cases

* Added more test cases

* Fixing test cases

* Removed circular dependency test case

* Cache version strings after first generation. (#1784)

* Cache version strings after first generation.

Also, rewrite CodeNamerGo method to be more readable and have fewer
allocations.

* Responding to PR comments.

* Adding missing package imports to template.

* Reversing change that made two fields static.

* Update readme to reflect requirements of repo build (#1719)

* Update ms_rest and ms_rest_azure version for tests

* Update minimum required runtime version message

* Fix bug in parameter grouping in some languages (#1775)

- The bug was that parameter group "transform" has to happen after the groups are
    processed. In CSharpAzure and CSharpFluent, it was happening too early and so the
    language specific capitalization rules wern't being applied.

* Fix ruby rspec test to deserialize post long-running operation

* fix cross referencing models in relative swagger specs (#1805)

* Fixed constant parameter (#1796)

* Make Python tests less nervous about Exception string content (#1781)

* [Go] Added x-ms-parametrized-host support (#1803)

* wip

* fix dat razor

* [Go] Adding support fo x-ms-parametrized-host

* Fixed bug 1763 and added unit tests (#1800)

* Fixed bug 1763 and added unit tests

* Fixed failing test

* Fixed comments

* Checking files for proper ctor text

* Addressed comment

* Fixing format bug preventing Go gen. (#1795)

* [Linter] Adding rule to warn about boolean type properties (#1783)

* Adding rule to warn about boolean type properties

* Adding test case for rule

* [ReadMe] Change commands to fixed width font (#1774)

* Hotfix after Java runtime beta5 release

* java tests

* regen

* merged
@mcardosos mcardosos deleted the param-host branch February 11, 2017 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants