arquillian / arquillian-cube

Control (docker, kubernetes, openshift) containers in your tests with ease!
http://arquillian.org/arquillian-cube/
120 stars 98 forks source link

Link to javadoc for io.fabric8.kubernetes.api.model.v2_2.* etc #739

Open mnuttall opened 7 years ago

mnuttall commented 7 years ago
Issue Overview

I'd like to write my own Kubernetes integration tests using Arquillian Cube. The docs at http://arquillian.org/arquillian-cube/#_examples point to https://github.com/arquillian/arquillian-cube/blob/master/kubernetes/ftest-kubernetes/src/test/java/HelloWorldTest.java which includes,

  import io.fabric8.kubernetes.api.model.v2_2.Service;
  // ...
  @Named("hello-world")
  @ArquillianResource
  Service helloWorld;

However the javadoc for io.fabric8.kubernetes.api.model.v2_2.Service is not linked to, and neither the source nor the javadoc can be found in github or via google. https://github.com/arquillian/arquillian-cube/blob/master/kubernetes/kubernetes/src/test/java/org/arquillian/cube/kubernetes/impl/MockTest.java makes it clear that the io.fabric8.kubernetes.api.model.v2_2 package contains many useful classes - but how are they to be used?

Expected Behaviour

A link to the necessary javadoc should be provided in the Arquillian Cube documentation.

Current Behaviour

The documentation and samples use important classes whose documentation, source and javadoc cannot be found.

Steps To Reproduce
  1. Search for javadoc for io.fabric8.kubernetes.api.model.v2_2.Service
  2. Search for source code for io.fabric8.kubernetes.api.model.v2_2.Service
  3. You have now reproduced the problem.
Additional Information

Arquillian Cube's Kubernetes support is very promising and we'd like to make good use of it: API documentation would go a long way to making this possible.

lordofthejars commented 7 years ago

This comes from a uber version of fabric8 kubernetes version,