Configuration des outils Salesforce DX
Objectifs de formation
- Décrire en quoi le modèle de développement d’organisation traditionnel diffère du développement de packages modulaires
- Décrire les principales caractéristiques d’un package
Premiers pas avec le développement orienté source
Salesforce DX ajoute des outils qui rationalisent l’ensemble du cycle de vie de développement. Il améliore la création et la collaboration des équipes, facilite les tests automatisés et l’intégration continue, et rend le cycle de publication plus efficace et agile.
Cependant, Salesforce DX est bien plus qu’un simple ensemble d’outils ! Il offre une alternative au développement d’ensembles de modifications et déplace la source d’informations fiables de l’organisation vers votre système de contrôle de version (VCS). Il réoriente votre objectif de développement, le faisant passer du développement organisationnel au développement de packages. Pour savoir comment migrer vos processus de développement existants vers le modèle de développement de packages, accédez au module Modèle de développement de packages.
Maintenant, trêve de bavardages. Êtes-vous prêt à vous lancer ? Commençons par configurer votre environnement et vous présenter quelques outils.
Définition d’une organisation test
De nombreux outils Salesforce DX vous permettent d’utiliser un type d’organisation appelé organisation test. Une organisation test est un environnement Salesforce dédié, configurable et à court terme. Les organisations test stimulent la productivité et la collaboration des développeurs pendant le processus de développement, et facilitent la réalisation de tests automatisés ainsi que l’intégration continue. Vous pouvez utiliser la CLI ou les extensions Salesforce pour VS Code afin d’ouvrir votre organisation test dans un navigateur sans vous connecter. Vous pouvez créer une organisation test aux fins suivantes :
- Démarrer un projet.
- Démarrer une nouvelle branche de fonctionnalité.
- Tester une nouvelle fonctionnalité.
- Démarrer des tests automatisés.
- Effectuer des tâches de développement directement dans une organisation.
- Partir de zéro avec une toute nouvelle organisation.
Bien que les organisations test ont pour vocation d’être à usage unique, leurs fichiers de configuration constituent une ressource précieuse. Grâce au fichier de configuration, vous pouvez configurer l’organisation test avec différentes éditions Salesforce et avec uniquement les fonctionnalités et paramètres souhaités. Vous pouvez également partager le fichier de configuration de l’organisation test avec d’autres membres de l’équipe. De cette façon, vous disposez tous de la même organisation de base dans laquelle réaliser votre développement.
Les sandbox, remplaçantes des organisations test ?
La réponse est non. Les organisations test n’ont pas vocation à se substituer aux sandbox ou aux organisations de production. En raison de leur nature éphémère (et de leur durée de vie maximale de 30 jours), les organisations test sont idéales pour développer une nouvelle fonctionnalité, une nouvelle personnalisation ou un nouveau package. Elle se prêtent également très bien à la réalisation de tests unitaires et à la mise en œuvre de l’intégration continue. Les sandbox, qui contiennent l’ensemble des métadonnées de votre organisation de production, sont toujours nécessaires pour les tests d’acceptation utilisateur finaux, la livraison continue et la préproduction.
Tout est clair pour vous ? Alors, poursuivez votre lecture…
Activer Dev Hub
Un Dev Hub vous offre, à vous et à votre équipe, la possibilité de créer et de gérer des organisations test. Les organisations test sont des environnements Salesforce temporaires dans lesquels vous réalisez l’essentiel de votre travail de développement, conformément à ce modèle de développement fondé sur la source.
Pour démarrer avec les organisations test, vous allez choisir une organisation qui fera office pour vous de Dev Hub. Même si vous pouvez activer Dev Hub dans n’importe quelle organisation rémunérée, nous vous recommandons de ne pas effectuer vos tests dans un environnement de production. À la place, activez Dev Hub dans une organisation Developer Edition ou Trailhead Playground pour l’utiliser dans le cadre de ce module. Vous pouvez trouver vos Trailhead Playgrounds existants ou en créer un en cliquant sur votre photo de profil, puis en sélectionnant Hands-On Orgs (Organisations d’exercice).
- Connectez-vous à l’organisation que vous avez choisie pour être votre Dev Hub.
- Dans Setup (Configuration), saisissez
Dev Hub
dans la zone Quick Find (Recherche rapide) et sélectionnez Dev Hub. - Cliquez sur le bouton pour activer Dev Hub.
Vous pouvez également faire de n’importe quelle organisation payante votre Dev Hub et y octroyer l’accès aux développeurs. Pour plus d’informations, reportez-vous au guide du développeur Salesforce DX.
Maintenant que vous disposez d’une organisation Dev Hub, configurons le reste de vos outils Salesforce DX.
Installation de Salesforce CLI
- Installez l’interface de ligne de commande à partir de https://developer.salesforce.com/tools/sfdxcli.
- Vérifiez que la CLI est correctement installée et à jour en exécutant la commande suivante à partir de la ligne de commande.
sf update
Une sortie semblable à la suivante doit s’afficher :@salesforce/cli:Updating CLI…
. La commande de mise à jour affiche ensuite les notes de publication de la version la plus récente.
Voici quelques autres commandes utiles pour vous aider à vous lancer :
Commande | Éléments qui s’affichent |
---|---|
sf --help |
Toutes les rubriques disponibles et les commandes générales. |
sf commands |
Toutes les commandes disponibles. |
-h
fournit des informations concises sur ce que font la commande et ses indicateurs. L’indicateur --help
fournit des descriptions détaillées et des exemples. Voici comment afficher les deux types d’aide relatives à une commande que vous allez bientôt exécuter : org login web
.sf org login web -h sf org login web --help
De nombreux indicateurs de commande CLI disposent à la fois d’un nom long et d’un nom court. Par exemple, de nombreuses commandes emploient --target-org
pour désigner une organisation, et le nom court de cet indicateur est -o
. Par souci de clarté, nous présentons uniquement des noms d’indicateurs longs dans ce module, mais n’hésitez pas à utiliser leurs noms courts si vous le souhaitez.
Continuons maintenant la configuration du reste des outils Salesforce DX.
Connexion à Dev Hub
Pour commencer, connectez-vous à Dev Hub à l’aide de la CLI afin d’être autorisé à créer des organisations test. Vous pouvez utiliser la commande org login web
pour vous connecter à diverses organisations. Nous vous proposons quelques possibilités pour vous aider à gérer ces organisations.
-
Pour autoriser le Dev Hub, utilisez le flux de connexion Web :
sf org login web --set-default-dev-hub --alias DevHub
Spécifiez l’indicateur--set-default-dev-hub
pour définir cette organisation comme Dev Hub par défaut. Utilisez l’indicateur--alias
pour définir un alias pour l’organisation (utilisez un nom accrocheur, comme DevHub). Un alias est bien plus facile à mémoriser que le nom d’utilisateur unique du Dev Hub.
Important : spécifiez l’indicateur--set-default-dev-hub
uniquement pour votre Dev Hub. Si vous l’utilisez avec une autre organisation, vous ne pourrez pas créer d’organisations test tant que vous n’aurez pas correctement identifié le Dev Hub à l’aide de la commandeconfig set
. - Connectez-vous avec vos identifiants dans la fenêtre de navigateur qui s’ouvre.
Une fois l’opération réussie, la CLI stocke de manière sécurisée le jeton ainsi que l’alias de l’organisation (DevHub, dans cet exemple). Vous pouvez fermer la fenêtre de navigateur de l’organisation Dev Hub à tout moment.
Par ailleurs, vous pouvez fermer le Dev Hub et créer tout de même des organisations test. Cependant, si vous souhaitez ouvrir l’organisation Dev Hub pour consulter les organisations test actives ou votre registre d’espace de noms, l’alias s’avère très pratique :
sf org open --target-org DevHub
Détails supplémentaires sur la gestion des organisations
Il est probable que vous ayez de nombreuses organisations, notamment des sandbox et votre organisation de production. Avec la CLI, vous pouvez également vous y connecter à l’aide de ces commandes. Lorsque vous vous connectez à une organisation à l’aide de la CLI, vous ajoutez cette organisation à la liste des organisations avec lesquelles la CLI pourra fonctionner à l’avenir.
Connexion aux sandbox
Si vous créez un alias pour la sandbox (indicateur --alias
), vous pouvez la référencer par cet alias au lieu d’employer son nom d’utilisateur long et souvent peu intuitif.
Par exemple :
sf org login web --instance-url https://MyDomainName--SandboxName.my.salesforce.com --alias FullSandbox sf org login web --instance-url https://MyDomainName--SandboxName.my.salesforce.com --alias DevSandbox
Si vous ne connaissez pas l’URL de connexion de votre organisation, vous pouvez la trouver sur la page Setup (Configuration) de Mon domaine.
Le pouvoir des alias
Comme vous pouvez l’imaginer, l’utilisation d’alias constitue un moyen puissant de gérer et de suivre vos organisations, et nous vous recommandons de vous en servir. Pourquoi ? Prenons l’exemple des noms d’utilisateur des organisations test. Le nom d’utilisateur d’une organisation test ressemble à ceci : test-7emx29rtpx0y@example.com
. Vous conviendrez que cela n’est pas facile à retenir. Ainsi, lorsque vous envoyez une commande qui nécessite le nom d’utilisateur de l’organisation, le fait d’utiliser un alias dont vous vous souvenez peut accélérer le processus.
sf org open --target-org FullSandbox sf org open --target-org MyScratchOrg sf limits api display --target-org DevSandbox
Affichage de toutes les organisations
À tout moment, vous pouvez exécuter la commande sf org list
pour voir toutes les organisations auxquelles vous êtes connecté. L’ajout de l’indicateur --all
vous fournit encore plus d’informations, en vous indiquant notamment quelles organisations test ont été récemment supprimées.
Vous êtes maintenant prêt à vous lancer : allons créer une application grâce à Salesforce CLI et aux organisations test.