/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
*  Licensed to Elasticsearch B.V. under one or more contributor
*  license agreements. See the NOTICE file distributed with
*  this work for additional information regarding copyright
*  ownership. Elasticsearch B.V. 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.
*/

using System;
using System.Linq;
using System.Threading.Tasks;
using OpenSearch.OpenSearch.Xunit.XunitPlumbing;
using OpenSearch.Net;
using FluentAssertions;
using OpenSearch.Client;
using Tests.Core.ManagedOpenSearch.Clusters;
using Tests.Core.ManagedOpenSearch.NodeSeeders;
using Tests.Domain;
using Tests.Framework.EndpointTests;
using Tests.Framework.EndpointTests.TestState;

namespace Tests.QueryDsl.Specialized.Percolate
{
	//hide
	public abstract class PercolateQueryUsageTestsBase
		: ApiIntegrationTestBase<
			WritableCluster,
			ISearchResponse<ProjectPercolation>,
			ISearchRequest,
			SearchDescriptor<ProjectPercolation>,
			SearchRequest<ProjectPercolation>
		>
	{
		protected static readonly string PercolatorId = RandomString();

		protected PercolateQueryUsageTestsBase(WritableCluster cluster, EndpointUsage usage) : base(cluster, usage) { }

		protected override bool ExpectIsValid => true;
		protected override int ExpectStatusCode => 200;
		protected override HttpMethod HttpMethod => HttpMethod.POST;
		protected string PercolationIndex => CallIsolatedValue + "-queries";

		protected override string UrlPath => $"{PercolationIndex}/_search";

		protected override LazyResponses ClientUsage() => Calls(
			(client, f) => client.Search(f),
			(client, f) => client.SearchAsync(f),
			(client, r) => client.Search<ProjectPercolation>(r),
			(client, r) => client.SearchAsync<ProjectPercolation>(r)
		);

		// https://youtrack.jetbrains.com/issue/RIDER-19912
		[U] protected override Task HitsTheCorrectUrl() => base.HitsTheCorrectUrl();

		[U] protected override Task UsesCorrectHttpMethod() => base.UsesCorrectHttpMethod();

		[U] protected override void SerializesInitializer() => base.SerializesInitializer();

		[U] protected override void SerializesFluent() => base.SerializesFluent();

		[I] public override async Task ReturnsExpectedStatusCode() => await base.ReturnsExpectedResponse();

		[I] public override async Task ReturnsExpectedIsValid() => await base.ReturnsExpectedIsValid();

		[I] public override async Task ReturnsExpectedResponse() => await base.AssertOnAllResponses(ExpectResponse);

		protected override void IntegrationSetup(IOpenSearchClient client, CallUniqueValues values)
		{
			foreach (var index in values.Values)
			{
				Client.Indices.Create(index, c => c
					.Settings(settings => settings
						.NumberOfShards(1)
						.NumberOfReplicas(0)
						.Analysis(DefaultSeeder.ProjectAnalysisSettings)
					)
					.Map<Project>(mm => mm.AutoMap()
						.Properties(DefaultSeeder.ProjectProperties)
					)
				);
				var percolationIndex = index + "-queries";
				Client.Indices.Create(percolationIndex, c => c
					.Settings(settings => settings
						.NumberOfShards(1)
						.NumberOfReplicas(0)
						.Analysis(DefaultSeeder.ProjectAnalysisSettings)
					)
					.Map<ProjectPercolation>(mm => mm.AutoMap()
						.Properties(DefaultSeeder.PercolatedQueryProperties)
					)
				);

				Client.Index(new ProjectPercolation
				{
					Id = PercolatorId,
					Query = new MatchQuery
					{
						Field = Infer.Field<Project>(f => f.LeadDeveloper.FirstName),
						Query = "Martijn"
					}
				}, d => d.Index(percolationIndex));
				Client.Index(Project.Instance, i => i.Routing(Project.Instance.Name));
				Client.Indices.Refresh(OpenSearch.Client.Indices.Index(percolationIndex).And<Project>());
			}
		}
	}

	/**
	* The percolate query can be used to match queries stored in an index.
	* The percolate query itself contains the document that will be used as query to match with the stored queries.
	*
	* IMPORTANT: In order for the percolate query to work, the index in which your stored queries reside must contain
	* a mapping for documents that you wish to percolate, so that they are parsed correctly at query time.
	*
	* See the OpenSearch documentation on {ref_current}/query-dsl-percolate-query.html[percolate query] for more details.
	*
	* In this example, we have a document stored with a `query` field that is mapped as a `percolator` type. This field
	* contains a `match` query.
	*/
	public class PercolateQueryUsageTests : PercolateQueryUsageTestsBase
	{
		public PercolateQueryUsageTests(WritableCluster i, EndpointUsage usage) : base(i, usage) { }

		protected ConditionlessWhen ConditionlessWhen => new ConditionlessWhen<IPercolateQuery>(a => a.Percolate)
		{
			q => { q.Document = null; }
		};

		//hide
		protected override Func<SearchDescriptor<ProjectPercolation>, ISearchRequest> Fluent => f =>
			f.Query(QueryFluent).Index(PercolationIndex);

		//hide
		protected override SearchRequest<ProjectPercolation> Initializer =>
			new SearchRequest<ProjectPercolation>(PercolationIndex)
			{
				Query = QueryInitializer
			};

		protected QueryContainer QueryInitializer => new PercolateQuery
		{
			Document = Project.Instance,
			Field = Infer.Field<ProjectPercolation>(f => f.Query)
		};

		protected object QueryJson => new
		{
			percolate = new
			{
				document = Project.InstanceAnonymous,
				field = "query"
			}
		};

		protected QueryContainer QueryFluent(QueryContainerDescriptor<ProjectPercolation> q) => q
			.Percolate(p => p
				.Document(Project.Instance)
				.Field(f => f.Query)
			);

		protected override void ExpectResponse(ISearchResponse<ProjectPercolation> response)
		{
			response.Total.Should().BeGreaterThan(0);
			response.Hits.Should().NotBeNull();
			response.Hits.Count().Should().BeGreaterThan(0);
			var match = response.Documents.First();
			match.Id.Should().Be(PercolatorId);
			((IQueryContainer)match.Query).Match.Should().NotBeNull();
		}
	}

	/**[float]
	* == Percolate an existing document
	* Instead of specifying the source of the document being percolated, the source can also be
	* retrieved from an already stored document. The percolate query will then internally execute a get request to fetch that document.
	*
	* The required fields to percolate an existing document are:
	* - `index` in which the document resides
	* - `type` of the document
	* - `field` that contains the query
	* - `id` of the document
	* - `document_type` type / mapping of the document
	*
	* See the OpenSearch documentation on {ref_current}/query-dsl-percolate-query.html[percolate query] for more details.
	*/
	public class PercolateQueryExistingDocumentUsageTests : PercolateQueryUsageTestsBase
	{
		public PercolateQueryExistingDocumentUsageTests(WritableCluster i, EndpointUsage usage) : base(i, usage) { }

		//hide
		protected override Func<SearchDescriptor<ProjectPercolation>, ISearchRequest> Fluent => f =>
			f.Query(QueryFluent).Index(PercolationIndex);

		//hide
		protected override SearchRequest<ProjectPercolation> Initializer =>
			new SearchRequest<ProjectPercolation>(PercolationIndex)
			{
				Query = QueryInitializer
			};

		protected QueryContainer QueryInitializer => new PercolateQuery
		{
			Index = IndexName.From<Project>(),
			Id = Project.Instance.Name,
			Routing = Project.Instance.Name,
			Field = Infer.Field<ProjectPercolation>(f => f.Query)
		};

		protected object QueryJson => new
		{
			percolate = new
			{
				type = "doc",
				index = "project",
				id = Project.Instance.Name,
				routing = Project.Instance.Name,
				field = "query"
			}
		};

		protected QueryContainer QueryFluent(QueryContainerDescriptor<ProjectPercolation> q) => q
			.Percolate(p => p
				.Index<Project>()
				.Id(Project.Instance.Name)
				.Routing(Project.Instance.Name)
				.Field(f => f.Query)
			);

		protected override void ExpectResponse(ISearchResponse<ProjectPercolation> response)
		{
			response.Total.Should().BeGreaterThan(0);
			response.Hits.Should().NotBeNull();
			response.Hits.Count().Should().BeGreaterThan(0);
			var match = response.Documents.First();
			match.Id.Should().Be(PercolatorId);
			((IQueryContainer)match.Query).Match.Should().NotBeNull();
		}
	}

	/**[float]
	* == Percolate multiple documents
	* The percolate query can match multiple documents simultaneously with the indexed percolator queries.
	* Percolating multiple documents in a single request can improve performance as queries
	* only need to be parsed and matched once instead of multiple times.
	*
	* See the OpenSearch documentation on {ref_current}/query-dsl-percolate-query.html[percolate query] for more details.
	*/
	public class PercolateMultipleDocumentsQueryUsageTests : PercolateQueryUsageTestsBase
	{
		public PercolateMultipleDocumentsQueryUsageTests(WritableCluster i, EndpointUsage usage) : base(i, usage) { }

		protected ConditionlessWhen ConditionlessWhen => new ConditionlessWhen<IPercolateQuery>(a => a.Percolate)
		{
			q => q.Documents = null
		};

		//hide
		protected override Func<SearchDescriptor<ProjectPercolation>, ISearchRequest> Fluent => f =>
			f.Query(QueryFluent).Index(PercolationIndex);

		//hide
		protected override SearchRequest<ProjectPercolation> Initializer =>
			new SearchRequest<ProjectPercolation>(PercolationIndex)
			{
				Query = QueryInitializer
			};

		protected QueryContainer QueryInitializer => new PercolateQuery
		{
			Documents = new[] { Project.Instance, Project.Instance, Project.Instance },
			Field = Infer.Field<ProjectPercolation>(f => f.Query)
		};

		protected object QueryJson => new
		{
			percolate = new
			{
				documents = new[]
				{
					Project.InstanceAnonymous,
					Project.InstanceAnonymous,
					Project.InstanceAnonymous
				},
				field = "query"
			}
		};

		protected QueryContainer QueryFluent(QueryContainerDescriptor<ProjectPercolation> q) => q
			.Percolate(p => p
				.Documents(Project.Instance, Project.Instance, Project.Instance)
				.Field(f => f.Query)
			);

		protected override void ExpectResponse(ISearchResponse<ProjectPercolation> response)
		{
			response.Total.Should().Be(1);
			response.Hits.Should().NotBeNull();
			response.Hits.Count.Should().Be(1);
			response.Fields.Count.Should().Be(1);

			var field = response.Fields.ElementAt(0);
			var values = field.ValuesOf<int>("_percolator_document_slot");
			values.Should().Contain(new[] { 0, 1, 2 });

			var match = response.Documents.First();
			match.Id.Should().Be(PercolatorId);
			((IQueryContainer)match.Query).Match.Should().NotBeNull();
		}
	}
}