Set Premium as the default ServerContext #853

PProfizi · 2023-03-22T16:34:46Z

Starting with dpf_server_2023.2.pre1, the licensing logic changes to an operator-based logic where each operator is tagged as either requiring a given (specific or any among a list) license to be checked-out, or as only requiring a license to exist.
This means the ServerContext being Premium means operators are allowed to check-out a license, and is the default behavior.
The ServerContext being Entry means operators are not allowed to check-out a license and will throw an error.

A DPF Server started with a Premium ServerContext cannot be set back to Entry.
Thus, the server_context.py/set_default_server_context() function should not try to apply an new default Entry context to an already running global server started as Premium.

For testing, having new servers being Premium by default means that:

no more need to set the default context as Premium in the conftest.py.
features to be tested as Entry should use a specific server started as Entry. They are moved to a specific folder and tested separately.

For examples:

no need to mark the examples as requiring Premium
no more need to set_default_server_context(Premium) in the first lines.
create an example on using an Entry server context

For Documentation:

update documentation to explain the new licensing logic

…ng Premium as it is now the new default. Keep them marked.

…lobal server already running.

codecov · 2023-03-22T17:11:33Z

Codecov Report

Merging #853 (3fe4f30) into master (0dd37a8) will increase coverage by 2.12%.
The diff coverage is 71.42%.

@@            Coverage Diff             @@
##           master     #853      +/-   ##
==========================================
+ Coverage   86.44%   88.57%   +2.12%     
==========================================
  Files          72       72              
  Lines        8220     8224       +4     
==========================================
+ Hits         7106     7284     +178     
+ Misses       1114      940     -174

…k_to_premium in conftest.py

…les.py

…folder

…ecursedies = *)

…tion (which runs everything on one python process, making the Inprocess server Premium)

cbellot000 · 2023-03-29T10:07:23Z

examples/00-basic/13-manage_licensing.py

@@ -0,0 +1,85 @@
+"""
+.. _ref_manage_licensing:


Hi @JennaPaikowsky, sorry for the late notice, I see that you were not added in the PR, would you mind giving us some feedback on this new example please? @PProfizi, can you follow up on Jenna's comment please?

JennaPaikowsky · 2023-03-29T12:06:44Z

docs/source/user_guide/getting_started_with_dpf_server.rst

+
+- **Premium:** This context, which is the default, allows DPF to perform license checkouts,


Premium: This default context allows DPF to perform license checkouts, .......

JennaPaikowsky · 2023-03-29T12:07:48Z

docs/source/user_guide/server_context.rst

- **Entry:** This context, which is the default, loads the minimum capabilities without requiring any license checkout.
- **Premium:** This context enables **Entry** capabilities and the capabilities that require a license checkout, making
-  more operators available.
+- **Premium:** This context, which is the default, allows DPF to perform license checkouts,


Same text change comment as previous.

JennaPaikowsky · 2023-03-29T12:08:43Z

docs/source/user_guide/server_context.rst

+    Server Context of type LicensingContextType.entry with no xml path
+
+.. warning::
+    As starting an ``InProcess`` server means linking the DPF binaries to your current python


to your current Python....

JennaPaikowsky · 2023-03-29T12:09:10Z

docs/source/user_guide/server_context.rst

+    process, you cannot start a new ``InProcess`` server. Thus, if your local ``InProcess`` server
+    is already **Premium**, you cannot set it back as **Entry**.
+    ``InProcess`` being the default server type, the proper commands to work as **Entry** should be
+    set right at the beginning of your script.


set at the start of your script.

cbellot000 · 2023-03-29T12:33:17Z

examples/00-basic/13-manage_licensing.py

+print(out)
+
+###############################################################################################
+# When Premium, using a LicenseContextManaged allows to control your interaction with a license


@PProfizi what does "control" mean, maybe you could describe what the LicenseContextManager can be used for?

@cbellot000 I am adding a bit more explanations, but compared to the examples in the dosctring of the LicenseContextManager, I personally would rather promote the with statement in this example compared to the rest.

JennaPaikowsky · 2023-03-29T12:36:16Z

examples/00-basic/13-manage_licensing.py

+"""
+.. _ref_manage_licensing:
+
+Manage the DPF licensing logic via the server context


Manage the DPF licensing logic using the server context

JennaPaikowsky · 2023-03-29T12:36:17Z

examples/00-basic/13-manage_licensing.py

+Manage the DPF licensing logic via the server context
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This examples shows how to manage the licensing logic of a DPF server using a `ServerContext`.


This example shows how....

JennaPaikowsky · 2023-03-29T12:37:10Z

examples/00-basic/13-manage_licensing.py

+
+This examples shows how to manage the licensing logic of a DPF server using a `ServerContext`.
+
+Preventing DPF from checking licenses out and blocking increments is possible


You can prevent DPF from checking licenses out and blocking increments by using the Entry context.

JennaPaikowsky · 2023-03-29T12:41:17Z

examples/00-basic/13-manage_licensing.py

+    is already **Premium**, you cannot set it back as **Entry**.
+    ``InProcess`` being the default server type, the proper commands to work as **Entry** should be
+    set right at the beginning of your script.
+


You cannot start a new InProcess server, as starting a server means linking the DPF binaries to your current Python process. If your local InProcess server is already set to Premium, you cannot set it back to Entry.

Since InProcess is the default server type, put the commands to set the Entry server context at the start of your script.

JennaPaikowsky · 2023-03-29T12:42:26Z

examples/00-basic/13-manage_licensing.py

+# The context is shown as Entry
+print(server.context)
+
+# A server of type InProcess being linked to the current python process,


JennaPaikowsky · 2023-03-29T12:43:10Z

examples/00-basic/13-manage_licensing.py

+print(out)
+
+###############################################################################################
+# When Premium, using a LicenseContextManaged allows to control your interaction with a license


allows you to control....

JennaPaikowsky · 2023-03-29T12:44:29Z

src/ansys/dpf/core/operator_specification.py

        Snake case name of the plugin it belongs to.

+    license: str
+        Optional license name to check out to run the operator.


Optional license name to check out that is used to run the operator.

JennaPaikowsky · 2023-03-29T12:45:04Z

src/ansys/dpf/core/server_context.py

 Gives the ability to choose the context with which the server should be started.
-The context allows to choose which capabilities are available.
-By default, an **Entry** type of :class:`ServerContext` is used.
+The context allows to choose the licensing logic for operators.


allows you to choose

PProfizi added 6 commits March 22, 2023 17:29

Set default SERVER_CONTEXT as premium

ab35a2b

Set default for set_default_server_context() as premium

5e12cf7

Remove set_default_server_context(Premium) line from examples requiri…

61982b2

…ng Premium as it is now the new default. Keep them marked.

Setting Premium as default at end of tests conftest.py is not needed

a64f50c

set_default_server_context does not try to apply Entry to a Premium g…

b8cc6f0

…lobal server already running.

Remove mentions to Premium in examples.

9a4efe3

PProfizi added the enhancement New feature or request label Mar 22, 2023

PProfizi self-assigned this Mar 22, 2023

PProfizi added this to the v0.7.5 milestone Mar 22, 2023

PProfizi added 12 commits March 22, 2023 18:36

Revert switch to _test in ci.yml

3f255d1

Moving entry tests to specific folder: remove fixture set_context_bac…

b6c167c

…k_to_premium in conftest.py

Moving entry tests to specific folder: remove duplicate in test_examp…

2bce0b2

…les.py

Moving entry tests to specific folder: remove from test_service.py

6f7f725

Moving entry tests to specific folder: create entry-specific testing …

2685efc

…folder

Move premium tests into premium

6d303ef

Fix test_context_environment_variable for Premium default

8447e84

Fix test_entry.py

677a2e4

Simplify entry/conftest.py

817b5b1

Move back main tests to root tests folder (thx to pytest.ini with nor…

dd78f16

…ecursedies = *)

Add Entry testing step to tests.yml

ae55056

Add Entry testing step to test_docker.yml

51cc3d2

PProfizi requested a review from cbellot000 March 23, 2023 15:16

PProfizi added 6 commits March 23, 2023 16:20

Remove useless setting of ANSYS_DPF_SERVER_CONTEXT=PREMIUM env

3c0bd50

Fix Test API Entry step

5b4d690

Fix Test API Entry step

8cc6ea2

Fix Test API Entry step

1021860

Fix code quality

e12cb63

Properly separate the entry test from the higher-level conftest

f71225c

cbellot000 approved these changes Mar 24, 2023

View reviewed changes

PProfizi added 13 commits March 24, 2023 15:11

Allow "license" as an optional custom python operator property

b5b2ac7

Allow "license" as an optional custom python operator property

f9a1e94

Filter out case where license=None

684cb5f

Improve docstring

893a028

Document any_dpf_supported_increments in the doc

77d0ebe

Redirect to stable doc

7b3c939

Fix fail in CI for example 13-manage_licensing.py

50afc31

Fix server_context.py

bbec1cd

Fix server_context.py

03c0c19

Mark example 13-manage_licensing.py as requiring DPF 6.1

12f5b92

Merge branch 'master' into feat/premium_as_default

3d0fc74

Debug docs job for example 13-manage_licensing.py

cb0872d

Update example 13-manage_licensing.py to work for docs gallery genera…

3fe4f30

…tion (which runs everything on one python process, making the Inprocess server Premium)

PProfizi merged commit 1b13263 into master Mar 27, 2023

PProfizi deleted the feat/premium_as_default branch March 27, 2023 11:50

cbellot000 reviewed Mar 29, 2023

View reviewed changes

JennaPaikowsky reviewed Mar 29, 2023

View reviewed changes

cbellot000 reviewed Mar 29, 2023

View reviewed changes

JennaPaikowsky reviewed Mar 29, 2023

View reviewed changes

PProfizi mentioned this pull request Mar 29, 2023

Doc/corrections to premium as default #867

Merged


		- Premium: This context, which is the default, allows DPF to perform license checkouts,


		This examples shows how to manage the licensing logic of a DPF server using a `ServerContext`.

		Preventing DPF from checking licenses out and blocking increments is possible

Set Premium as the default ServerContext #853

Set Premium as the default ServerContext #853

Uh oh!

Conversation

PProfizi commented Mar 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cbellot000 Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PProfizi Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

PProfizi commented Mar 22, 2023 •

edited

Loading

codecov bot commented Mar 22, 2023 •

edited

Loading

cbellot000 Mar 29, 2023 •

edited

Loading

PProfizi Mar 29, 2023 •

edited

Loading