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

Mesh Testframework - key functionalities not yet implemented / mismatch with your documentation #1124

Open
bbelghith opened this issue Sep 16, 2020 · 3 comments
Labels

Comments

@bbelghith
Copy link

In your current documentation of plugin development - You describe there a framework that is in fact not fully implemented.
Can you please update your documentation ? I suggest to put it into state "experimental" and warn that several functionalities are not working yet.

I wanted to use your client for some basic test scenarios - like API token access or login-based access.

com.gentics.mesh.rest.MeshLocalClientImpl

@OverRide
public MeshRestClient setLogin(String username, String password) {
// TODO Auto-generated method stub
return null;
}

@Override
public MeshRestClient setLogin(String username, String password, String newPassword) {
	return null;
}

@Override
public MeshRestClient setAPIKey(String apiKey) {
	// TODO Auto-generated method stub
	return null;
}

Gentics Mesh Version, operating system, or hardware.

  • v1.3.2

Operating System

  • Linux
  • MacOSX
  • Windows
  • Other, name?

JVM

  • Oracle JDK 1.8.0_100
  • Open JDK 1.8.0_100

Problem

Reproducer

Expected behaviour and actual behaviour

@Jotschi
Copy link
Contributor

Jotschi commented Sep 16, 2020

The MeshLocalClientImpl class is part of the core and not part of the public API.

@Jotschi
Copy link
Contributor

Jotschi commented Sep 16, 2020

The use of the client is also not documented or suggested anywhere in the documentation.
The client is purely used for internal and testing purposes.

@bbelghith
Copy link
Author

bbelghith commented Sep 22, 2020

Hello Jotschi,
please be aware that there is potential for misunderstandings and find potential for improvement.

I came to this point via the mesh documentation:

You are referring to plugin examples in the doc here:
https://getmesh.io/docs/plugin-development/

You showing the client here: GraphQlExamplePluginTest.java

and in this referred test example.
https://github.com/gentics/mesh-plugin-examples/blob/master/authentication-plugin/src/test/java/com/gentics/mesh/plugin/AuthenticationExamplePluginTest.java

where you use client.setAPIKey(null) which always returns null.

Sure you are using null here but there nowhere stated that this is the only thing you can do because the method returns null.
I am not sure what you want to demonstrate by this but i find it misleading.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants