Skip to content

Commit

Permalink
Merge pull request #442 from 3scale/fix/missing-route-status-ingress
Browse files Browse the repository at this point in the history 
Merge pull request #441 from 3scale/fix/missing-route-status-ingress
  • Loading branch information
@guicassolato
guicassolato authored Mar 11, 2021
2 parents 69508ee + 2acfcf5 commit 23c47c8
Show file tree
Hide file tree
Showing 3 changed files with 214 additions and 22 deletions.
12 changes: 10 additions & 2 deletions app/services/integration/kubernetes_service.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,9 +254,17 @@ def initialize(condition)
end
end

class MissingStatusIngress < InvalidStatus
MISSING_STATUS_INGRESS_CONDITION = ActiveSupport::OrderedOptions.new.merge(type: 'unknown', reason: 'unknown', message: "Kubernetes resource status missing 'ingress' property").freeze

def initialize
super(MISSING_STATUS_INGRESS_CONDITION)
end
end

def verify_route_status(route)
ingress = route.status.ingress.find { |ingress| ingress.host == route.spec.host }
condition = ingress.conditions.find { |condition| condition.type = 'Admitted' }
ingress = (route.status.ingress or raise MissingStatusIngress).find { |ingress| ingress.host == route.spec.host }
condition = ingress.conditions.find { |condition| condition.type == 'Admitted' }

raise InvalidStatus, condition unless condition.status == 'True'
end
Expand Down
6 changes: 4 additions & 2 deletions test/fixtures/entries.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ client:
created_at: <%= 1.week.ago %>

service:
data:
data:
tenant: two
model: service

Expand All @@ -41,6 +41,8 @@ proxy:

provider:
data:
service_id: 2
id: 2
domain: provider.example.com
admin_domain: provider-admin.example.com
tenant: two
model: provider
218 changes: 200 additions & 18 deletions test/services/kubernetes_service_test.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def after_teardown
super
end

test 'create ingress ' do
setup do
ENV['KUBERNETES_NAMESPACE'] = 'zync'
ENV['KUBE_TOKEN'] = strict_encode64('token')
ENV['KUBE_SERVER'] = 'http://localhost'
Expand All @@ -33,40 +33,208 @@ def after_teardown
-----END CERTIFICATE-----
CERTIFICATE

service = Integration::KubernetesService.new(nil)
@service = Integration::KubernetesService.new(nil)
end

attr_reader :service

test 'create ingress' do
proxy = entries(:proxy)

stub_request(:get, 'http://localhost/apis/route.openshift.io/v1').
with(
headers: {
'Accept'=>'application/json',
'Authorization'=>'Bearer token',
}).
with(headers: request_headers).
to_return(status: 200, body: {
kind: "APIResourceList",
apiVersion: "v1",
groupVersion: "route.openshift.io/v1",
kind: 'APIResourceList',
apiVersion: 'v1',
groupVersion: 'route.openshift.io/v1',
resources: [
{ name: "routes", singularName: "", namespaced: true, kind: "Route", verbs: %w(create delete deletecollection get list patch update watch), categories: ["all"] },
{ name: 'routes', singularName: '', namespaced: true, kind: 'Route', verbs: %w(create delete deletecollection get list patch update watch), categories: ['all'] },
]
}.to_json, headers: { 'Content-Type' => 'application/json' })
}.to_json, headers: response_headers)

stub_request(:get, 'http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes?labelSelector=3scale.net/created-by=zync,3scale.net/tenant_id=298486374,zync.3scale.net/record=Z2lkOi8venluYy9Qcm94eS8yOTg0ODYzNzQ,zync.3scale.net/ingress=proxy,3scale.net/service_id=2').
with(
headers: {
'Accept'=>'application/json',
'Authorization'=>'Bearer token',
}).
with(headers: request_headers).
to_return(status: 200, body: {
kind: 'RouteList',
apiVersion: 'route.openshift.io/v1',
metadata: { selfLink: '/apis/route.openshift.io/v1/namespaces/zync/routes', resourceVersion: '651341' },
items: [] }.to_json, headers: { 'Content-Type' => 'application/json' })
items: []
}.to_json, headers: response_headers)

service.call(proxy)
end

test 'route status missing ingress' do
# stub api resource list requests (kinds 'pods' and 'routes')
stub_request(:get, 'http://localhost/api/v1').
with(headers: request_headers).
to_return(status: 200, body: {
kind: 'APIResourceList',
apiVersion: 'v1',
groupVersion: 'apps.3scale.net/v1alpha1',
resources: [
{ name: 'pods', singularName: '', namespaced: true, kind: 'pod', verbs: %w(create delete deletecollection get list patch update watch), categories: ['all'] },
]
}.to_json, headers: response_headers)

stub_request(:get, 'http://localhost/apis/route.openshift.io/v1').
with(headers: request_headers).
to_return(status: 200, body: {
kind: 'APIResourceList',
apiVersion: 'v1',
groupVersion: 'route.openshift.io/v1',
resources: [
{ name: 'routes', singularName: '', namespaced: true, kind: 'Route', verbs: %w(create delete deletecollection get list patch update watch), categories: ['all'] },
]
}.to_json, headers: response_headers)

# stub route owner
ENV['POD_NAME'] = 'zync-que-123'
route_owner = { kind: 'Pod', apiVersion: 'v1', metadata: { name: 'zync-que-123', generateName: 'zync-que-', namespace: 'zync', selfLink: '/api/v1/namespaces/zync/pods/zync-que-123', uid: 'b145c845-7222-44ce-8d9d-f13b8f357de6', resourceVersion: '3620670' } }

stub_request(:get, "http://localhost/api/v1/namespaces/zync/pods/#{route_owner.dig(:metadata, :name)}").
with(headers: request_headers).
to_return(status: 200, body: route_owner.to_json, headers: response_headers)

route_owner_reference = route_owner.slice(:kind, :apiVersion).merge(**route_owner[:metadata].slice(:name, :uid), controller: nil, blockOwnerDeletion: nil)

# base objects for creating provider routes
entry = entries(:provider)
provider_id = entry.data.fetch('id')
provider = entry.model.record
tenant_id = entry.tenant_id
record_gid = provider.to_gid_param

provider_route_labels = {
'3scale.net/created-by' => 'zync',
'3scale.net/tenant_id' => tenant_id.to_s,
'zync.3scale.net/record' => record_gid,
'zync.3scale.net/ingress' => 'provider',
'3scale.net/provider_id' => provider_id.to_s
}

provider_route_annotations = {
'3scale.net/gid' => entry.to_gid.to_s,
'zync.3scale.net/gid' => provider.to_gid.to_s
}

route_list = {
kind: 'RouteList',
apiVersion: 'route.openshift.io/v1',
metadata: { selfLink: '/apis/route.openshift.io/v1/namespaces/zync/routes', resourceVersion: '651341' },
items: []
}

# stub for creating provider route to system-developer
system_developer_route_labels = provider_route_labels.merge('zync.3scale.net/route-to' => 'system-developer')
system_developer_route_annotations = provider_route_annotations.merge('zync.3scale.net/host' => 'provider.example.com')
system_developer_route = {
kind: 'Route',
apiVersion: 'route.openshift.io/v1',
metadata: {
namespace: 'zync',
name: 'zync-3scale-provider-grvkd',
uid: '3882e5dc-1f8f-460e-a1cc-ee4c5f35a709',
selfLink: '/apis/route.openshift.io/v1/namespaces/zync/routes/zync-3scale-provider-grvkd',
labels: system_developer_route_labels,
annotations: system_developer_route_annotations
},
status: {}
}

stub_request(:get, "http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes?labelSelector=3scale.net/created-by=zync,3scale.net/tenant_id=#{tenant_id},zync.3scale.net/record=#{record_gid},zync.3scale.net/route-to=system-developer").
with(headers: request_headers).
to_return(status: 200, body: route_list.to_json, headers: response_headers)

stub_request(:post, 'http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes').
with(headers: request_headers, body: {
metadata: {
generateName: 'zync-3scale-provider-',
namespace: 'zync',
labels: system_developer_route_labels,
ownerReferences: [route_owner_reference],
annotations: system_developer_route_annotations
},
spec: {
host: 'provider.example.com',
port: { targetPort: 'http' },
to: { kind: 'Service', name: 'system-developer' },
tls: { insecureEdgeTerminationPolicy: 'Redirect', termination: 'edge' }
},
apiVersion: 'route.openshift.io/v1',
kind: 'Route'
}.to_json).
to_return(status: 201, body: system_developer_route.to_json, headers: response_headers)

route_list[:metadata][:resourceVersion] = '651342'
route_list[:items] = [system_developer_route]

stub_request(:get, 'http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes').
with(headers: request_headers).
to_return(status: 200, body: route_list.to_json, headers: response_headers)

stub_request(:get, "http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes/#{system_developer_route.dig(:metadata, :name)}").
with(headers: request_headers).
to_return(status: 200, body: system_developer_route.to_json, headers: response_headers)

# stub for creating provider route to system-provider
system_provider_route_labels = provider_route_labels.merge('zync.3scale.net/route-to' => 'system-provider')
system_provider_route_annotations = provider_route_annotations.merge('zync.3scale.net/host' => 'provider-admin.example.com')
system_provider_route = {
kind: 'Route',
apiVersion: 'route.openshift.io/v1',
metadata: {
namespace: 'zync',
name: 'zync-3scale-provider-rbpqw',
uid: 'f741703c-7ca5-4480-8a32-074fcc759583',
selfLink: '/apis/route.openshift.io/v1/namespaces/zync/routes/zync-3scale-provider-rbpqw',
labels: system_developer_route_labels,
annotations: system_developer_route_annotations
},
status: {}
}

stub_request(:get, "http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes?labelSelector=3scale.net/created-by=zync,3scale.net/tenant_id=#{tenant_id},zync.3scale.net/record=#{record_gid},zync.3scale.net/route-to=system-provider").
with(headers: request_headers).
to_return(status: 200, body: route_list.merge(items: []).to_json, headers: response_headers)

stub_request(:post, 'http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes').
with(headers: request_headers, body: {
metadata: {
generateName: 'zync-3scale-provider-',
namespace: 'zync',
labels: system_provider_route_labels,
ownerReferences: [route_owner_reference],
annotations: system_provider_route_annotations
},
spec: {
host: 'provider-admin.example.com',
port: { targetPort: 'http' },
to: { kind: 'Service', name: 'system-provider' },
tls: { insecureEdgeTerminationPolicy: 'Redirect', termination: 'edge' }
},
apiVersion: 'route.openshift.io/v1',
kind: 'Route'
}.to_json).
to_return(status: 201, body: system_provider_route.to_json, headers: response_headers)

route_list[:metadata][:resourceVersion] = '651343'
route_list[:items] = [system_developer_route, system_provider_route]

stub_request(:get, 'http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes').
with(headers: request_headers).
to_return(status: 200, body: route_list.to_json, headers: response_headers)

stub_request(:get, "http://localhost/apis/route.openshift.io/v1/namespaces/zync/routes/#{system_provider_route.dig(:metadata, :name)}").
with(headers: request_headers).
to_return(status: 200, body: system_provider_route.to_json, headers: response_headers)

# create both routes
assert_raises(Integration::KubernetesService::MissingStatusIngress) do
service.call(entry)
end
end

class RouteSpec < ActiveSupport::TestCase
test 'secure routes' do
url = 'https://my-api.example.com'
Expand Down Expand Up @@ -108,4 +276,18 @@ class RouteSpec < ActiveSupport::TestCase
assert_equal json, spec.to_hash
end
end

protected

def request_headers
{
'Accept' => 'application/json',
'Authorization' => 'Bearer token',
'Host' => 'localhost:80'
}
end

def response_headers
{ 'Content-Type' => 'application/json' }
end
end

0 comments on commit 23c47c8

Please sign in to comment.