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

Update verify repository to allow unknown fields #37619

Merged
merged 7 commits into from
Jan 30, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.elasticsearch.client.watcher;

import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryResponse;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.common.xcontent.json.JsonXContent;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.test.XContentTestUtils;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static org.elasticsearch.test.AbstractXContentTestCase.xContentTester;

public class VerifyRepositoryResponseTests extends ESTestCase {

public void testFromXContent() throws IOException {
xContentTester(this::createParser,
VerifyRepositoryResponseTests::createTestInstance,
VerifyRepositoryResponseTests::toXContent,
VerifyRepositoryResponse::fromXContent)
.supportsUnknownFields(false)
Copy link
Member

Choose a reason for hiding this comment

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

Should this be true since this supports unknown fields now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thx for pointing it out. it was like that initially because i was manually adding extra junk to each item in the list inside the response because of what i thought was a limitation in the framework.. but i saw the path filter recently and realized that could be used to stop injecting nonvalid objects into the contents of a list.

.shuffleFieldsExceptions(new String[] {"nodes"}) // do not mix up the order of nodes, it will cause the tests to fail
.assertToXContentEquivalence(false)
.test();
}

private static VerifyRepositoryResponse createTestInstance() {
List<VerifyRepositoryResponse.NodeView> nodes = new ArrayList<>();
for (int i = 0; i < randomIntBetween(0, 2); i++) {
nodes.add(new VerifyRepositoryResponse.NodeView(randomAlphaOfLength(5), randomAlphaOfLength(5)));
}

return new VerifyRepositoryResponse(nodes);
}

private static XContentBuilder toXContent(VerifyRepositoryResponse.NodeView node, XContentBuilder builder) throws IOException {
// Use a temp builder to create the object we want to add random fields to
XContentBuilder tempBuilder = JsonXContent.contentBuilder().startObject().field("name", node.getName()).endObject();
BytesReference newBytes = XContentTestUtils.insertRandomFields(XContentType.JSON, BytesReference.bytes(tempBuilder),
null, random());

// add the temp object into the actual builder
builder.rawField(node.getNodeId(), newBytes.streamInput(), XContentType.JSON);

return builder;
}

private static XContentBuilder toXContent(VerifyRepositoryResponse response, XContentBuilder builder) throws IOException {
builder.startObject();
{
builder.startObject("nodes");
{
for (VerifyRepositoryResponse.NodeView node : response.getNodes()) {
toXContent(node, builder);
}
}
builder.endObject();
}
builder.endObject();
return builder;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public class VerifyRepositoryResponse extends ActionResponse implements ToXConte
public static class NodeView implements Writeable, ToXContentObject {
private static final ObjectParser.NamedObjectParser<NodeView, Void> PARSER;
static {
ObjectParser<NodeView, Void> internalParser = new ObjectParser<>(NODES);
ObjectParser<NodeView, Void> internalParser = new ObjectParser<>(NODES, true, null);
internalParser.declareString(NodeView::setName, new ParseField(NAME));
PARSER = (p, v, name) -> internalParser.parse(p, new NodeView(name), null);
}
Expand Down Expand Up @@ -110,7 +110,7 @@ public int hashCode() {
private List<NodeView> nodes;

private static final ObjectParser<VerifyRepositoryResponse, Void> PARSER =
new ObjectParser<>(VerifyRepositoryResponse.class.getName(), VerifyRepositoryResponse::new);
new ObjectParser<>(VerifyRepositoryResponse.class.getName(), true, VerifyRepositoryResponse::new);
static {
PARSER.declareNamedObjects(VerifyRepositoryResponse::setNodes, NodeView.PARSER, new ParseField("nodes"));
}
Expand All @@ -122,6 +122,10 @@ public VerifyRepositoryResponse(DiscoveryNode[] nodes) {
this.nodes = Arrays.stream(nodes).map(dn -> new NodeView(dn.getId(), dn.getName())).collect(Collectors.toList());
}

public VerifyRepositoryResponse(List<NodeView> nodes) {
this.nodes = nodes;
}

@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
Expand Down Expand Up @@ -168,19 +172,15 @@ public String toString() {
}

@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
VerifyRepositoryResponse other = (VerifyRepositoryResponse) obj;
return nodes.equals(other.nodes);
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
VerifyRepositoryResponse that = (VerifyRepositoryResponse) o;
return Objects.equals(nodes, that.nodes);
}

@Override
public int hashCode() {
return nodes.hashCode();
return Objects.hash(nodes);
}
}