Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

ALR Skunkworks testing: Java as a docs language #1267

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ALR Skunkworks testing: Java as a docs language #1267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion shnippet.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"rootDirectory": "./site/testsuites",
"outputDirectory": "./site/snippets",
"fileExtensions": [".js", ".ts", ".kt", ".gradle", ".xml", ".bash"],
"fileExtensions": [".java", ".js", ".ts", ".kt", ".gradle", ".xml", ".bash"],
"exclude": ["pfiOverviewReadOfferingsJs", "pfiOverviewWriteJs", "pfiOverviewWriteOfferingsJs"],
"snippetTags": {
"start": ":snippet-start:",
Expand Down
21 changes: 18 additions & 3 deletions site/docs/web5/build/decentralized-identifiers/how-to-create-did.mdx
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make a clone of this doc and experiment with that one. I'm trying to get everyone to stop experimenting in our most widely used guide, as we've had to urgently do a fast-follow twice before (late at night) when changes have been merged and this top priority doc has been broken

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pay no attention to that man behind the curtain. 🤣

Looks like I picked a hot article to port over as my end-to-end test. Not to worry - this PR isn't destined for any merge to main until we have cross-team coordination. It introduces an experimental feature I'm vetting. You won't be needing any late night fixes from this, my Island of Misfit Toys.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import createADidDependencyGradle from '!!raw-loader!@site/snippets/testsuite-ja
import createADidDependencyMaven from '!!raw-loader!@site/snippets/testsuite-javascript/__tests__/web5/build/decentralized-identifiers/createADidDependencyMaven.snippet.xml';
import createADidDependency from '!!raw-loader!@site/snippets/testsuite-javascript/__tests__/web5/build/decentralized-identifiers/createADidDependency.snippet.bash';

<LanguageSwitcher languages="JavaScript, Kotlin" />
<LanguageSwitcher languages="JavaScript, Kotlin, Java" />

# Create a DID

Expand All @@ -34,7 +34,20 @@ You can create a DID using any of the [Web5-supported DID methods](/docs/web5/le
nestedSnippets: {
Gradle: {
snippet: createADidDependencyGradle,
language: 'js',
language: 'kt',
},
Maven: {
snippet: createADidDependencyMaven,
language: 'xml',
},
},
},
{
language: 'Java',
nestedSnippets: {
Gradle: {
snippet: createADidDependencyGradle,
language: 'kt',
},
Maven: {
snippet: createADidDependencyMaven,
Expand Down Expand Up @@ -63,6 +76,7 @@ The following DID methods are supported:
snippets={[
{ snippetName: 'createDidDht', language: 'JavaScript' },
{ snippetName: 'createDidDhtKt', language: 'Kotlin' },
{ snippetName: 'createDidDhtJava', language: 'Java' },
]}
/>

Expand All @@ -73,6 +87,7 @@ The following DID methods are supported:
snippets={[
{ snippetName: 'createDidJwk', language: 'JavaScript' },
{ snippetName: 'createDidJwkKt', language: 'Kotlin' },
{ snippetName: 'createDidJwkJava', language: 'Java' },
]}
/>

Expand Down Expand Up @@ -229,4 +244,4 @@ In the example below, the `d` property of the private key component is masked. T
}
]
}
```
```
3 changes: 2 additions & 1 deletion site/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,8 @@ let config = {
},
],
},
additionalLanguages: ['kotlin', 'swift', 'dart', 'rust'],
// Must add Scala here to work around a Redoc bug: https://github.com/facebook/docusaurus/issues/7209
additionalLanguages: ['kotlin', 'swift', 'dart', 'rust', 'java', 'scala'],
},
}),
};
Expand Down
1 change: 1 addition & 0 deletions site/src/components/CodeSnippet.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import codeSnippets from '../../src/util/code-snippets-map.json'; // Import for
// Define the language map for the new system
const languageExtensionMap = {
javascript: 'js',
java: 'java',
kotlin: 'kt',
swift: 'swift',
dart: 'dart',
Expand Down
13 changes: 13 additions & 0 deletions site/testsuites/kotlin-testsuite.iml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<module version="4">
<component name="AutoImportedSourceRoots">
<option name="directories">
<list>
<option value="$MODULE_DIR$/testsuite-kotlin/src/main/java" />
<option value="$MODULE_DIR$/testsuite-kotlin/src/main/kotlin" />
<option value="$MODULE_DIR$/testsuite-kotlin/src/test/java" />
<option value="$MODULE_DIR$/testsuite-kotlin/src/test/kotlin" />
</list>
</option>
</component>
</module>
13 changes: 13 additions & 0 deletions site/testsuites/testsuite-kotlin/kotlin-testsuite.iml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<module version="4">
<component name="AutoImportedSourceRoots">
<option name="directories">
<list>
<option value="$MODULE_DIR$/src/main/java" />
<option value="$MODULE_DIR$/src/main/kotlin" />
<option value="$MODULE_DIR$/src/test/java" />
<option value="$MODULE_DIR$/src/test/kotlin" />
</list>
</option>
</component>
</module>
65 changes: 63 additions & 2 deletions site/testsuites/testsuite-kotlin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>17</java.version>
<kotlin.jvm.target>17</kotlin.jvm.target>
<kotlin.compiler.incremental>true</kotlin.compiler.incremental>
<version.assertj>3.25.2</version.assertj>
Expand Down Expand Up @@ -121,8 +122,8 @@
</dependencies>

<build>
<sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
<testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
<sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
<testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
<plugins>
<!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
Expand Down Expand Up @@ -179,6 +180,66 @@
<configuration>
<jvmTarget>${kotlin.jvm.target}</jvmTarget>
</configuration>
<executions>
<execution>
<id>compile</id>
<phase>process-sources</phase>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/main/java</sourceDir>
<sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
</sourceDirs>
</configuration>
</execution>
<execution>
<id>test-compile</id>
<phase>process-test-sources</phase>
<goals>
<goal>test-compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/test/java</sourceDir>
<sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
</sourceDirs>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
<executions>
<execution>
<id>default-compile</id>
<phase>none</phase>
</execution>
<execution>
<id>default-testCompile</id>
<phase>none</phase>
</execution>
<execution>
<id>java-compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
<execution>
<id>java-test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>testCompile</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Expand Down
63 changes: 63 additions & 0 deletions .../tbd/developer/site/java/docs/web5/build/decentralizedidentifiers/HowToCreateDidTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package website.tbd.developer.site.java.docs.web5.build.decentralizedidentifiers;

import foundation.identity.did.DIDDocument;
import org.junit.jupiter.api.Test;
import web5.sdk.crypto.InMemoryKeyManager;
import web5.sdk.dids.DidResolutionResult;
import web5.sdk.dids.methods.dht.CreateDidDhtOptions;
import web5.sdk.dids.methods.dht.DidDht;
import web5.sdk.dids.methods.jwk.DidJwk;
import web5.sdk.dids.methods.key.DidKey;

import static org.junit.jupiter.api.Assertions.*;

class HowToCreateDidTest
{

@Test
void createDidDht(){

// :snippet-start: createDidDhtJava
// Creates a DID using the DHT method and publishes the DID Document to the DHT
final DidDht didDht = DidDht.Default.create(
new InMemoryKeyManager(),
new CreateDidDhtOptions(null,null,true,null,null));

// DID String
final String did = didDht.getUri();

// DID and its associated data which can be exported and used in different contexts/apps
final DidResolutionResult portableDid = DidDht.Default.resolve(did,null);

// DID Document
final DIDDocument didDocument = portableDid.getDidDocument();
// :snippet-end:

assertNotNull(did,"DID should not be null");
assertTrue(did.startsWith("did:dht"),"Did should start with 'did:dht'");
assertEquals(did, didDocument.getId().toString(),"ID of DID Document should match DID");
}

@Test
void createDidJwt() {
// :snippet-start: createDidJwkJava
// Creates a DID using the did:jwk method
final DidJwk didJwk = DidJwk.Companion.create(new InMemoryKeyManager(), null);

// DID and its associated data which can be exported and used in different contexts/apps
final DidResolutionResult portableDid = didJwk.resolve();

// DID String
final String did = didJwk.getUri();

// DID Document
final DIDDocument didDocument = portableDid.getDidDocument();
// :snippet-end:

assertNotNull(did, "DID should not be null");
assertTrue(did.startsWith("did:jwk"), "DID should start with 'did:jwk'");
assertNotNull(didDocument, "DID Document should not be null");
assertEquals(did, didDocument.getId().toString(),"ID od DID Document should match DID");
}

}
Loading